Bloqueio Geográfico para Aluno

Route (Rota)

Método Rota Descrição
PUT /webservice/student/geographic Retorna os dados de um aluno da plataforma.

Headers (Cabeçalho)

Param Tipo Descrição Obrigatório
Accept String application/json Sim
content-type String application/json Sim
secret String *Secret Key Sim
token String **Webservice Token Sim

*Para conseguir a Secret Key acesse sua Plataforma, abra o Menu, vá na área de Usuários e acesse Webservice, lá você terá a lista de usuários com suas respectivas Secret Key

** Token gerado pela rota de autenticação

Body params (Parâmetros)

Param Tipo Descrição Obrigatório
student_id String Id do aluno Não
document_type String *Tipo de documento - Ex.: CPF Não
document String Documento do aluno - Ex.: XXX.XXX.XXX-XX Não
status String Status do bloqueio geográfico 0 ou 1, por padrão 0 (desativado) Não
* Os tipos de documentos padrões da plataforma são: CPF, RG e CNPJ

Exemplos

cURL

				
					curl --location --request PUT 'https://dev3.nochalks.com/webservice/student/geographic' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'secret: {{._webservice_sercret}}' \
--header 'token: {{._webservice_token}}' \
--data '{
  "document_type": "cpf",
  "document": "106.513.276-01",
  "status": 0
}'
				
			

Node.js

				
					const axios = require('axios');
let data = JSON.stringify({
  "document_type": "cpf",
  "document": "106.513.276-01",
  "status": 0
});

let config = {
  method: 'put',
  maxBodyLength: Infinity,
  url: 'https://dev3.nochalks.com/webservice/student/geographic',
  headers: { 
    'Content-Type': 'application/json', 
    'Accept': 'application/json', 
    'secret': '{{._webservice_sercret}}', 
    'token': '{{._webservice_token}}'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

				
			

PHP

				
					<?php
$client = new Client();
$headers = [
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'secret' => '{{._webservice_sercret}}',
  'token' => '{{._webservice_token}}'
];
$body = '{
  "document_type": "cpf",
  "document": "106.513.276-01",
  "status": 0
}';
$request = new Request('PUT', 'https://dev3.nochalks.com/webservice/student/geographic', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

				
			

Request (Requisição)

- Request com ID do Aluno

				
					{
	"id": 3,
	"status": 1
}
				
			

- Request com Documento do Aluno

				
					{
	"document_type": "cpf",
	"document": "999.999.999-99",
	"status": 0
}
				
			

Response (Respostas)

- Aluno atualizado (Status: 200)

				
					{
  "message": "Atualizado",
  "status": "200",
  "data": {
    "id": "3",
    "document_type": "RG",
    "document": "1",
    "geographic_lock": false,
    "profile": {
      "instagram": null,
      "facebook": null,
      "twitter": null,
      "linkedin": null,
      "website": null,
      "picture": null
    },
    "user": {
      "name": "Teste",
      "email": "email@email.com",
      "expires_at": null
    },
    "secondaries": [],
    "form": null
  }
}
				
			
ESCOLHA UM ATENDIMENTO:
Contato por Chat CHAT
Contato por E-mail E-MAIL
Contato por Telefone TELEFONE
Contato por Whatsapp WHATSAPP
Plataforma EAD para Cursos e Treinamentos Online mais segura do mercado!
Privacy Overview

This website uses cookies so that we can provide you with the best user experience possible. Cookie information is stored in your browser and performs functions such as recognising you when you return to our website and helping our team to understand which sections of the website you find most interesting and useful.