Consultar Aluno

Route (Rota)

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

Headers (Cabeçalho)

Param Tipo Descrição Obrigatório
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

Query 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

* Os tipos de documento padrão da plataforma são: CPF, RG e CNPJ

Exemplos

cURL

				
					curl --location 'https://dev3.nochalks.com/student?student_id=4&document=000.000.000-00&document_type=CPF' \
--header 'Accept: application/json' \
--header 'secret: {{._webservice_secret}}' \
--header 'token: {{._webservice_token}}'

				
			

Node.js

				
					const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://dev3.nochalks.com/student?student_id=4&document=000.000.000-00&document_type=CPF',
  headers: { 
    'Accept': 'application/json', 
    'secret': '{{._webservice_secret}}', 
    'token': '{{._webservice_token}}'
  }
};

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

				
			

PHP

				
					<?php
$client = new Client();
$headers = [
  'Accept' => 'application/json',
  'secret' => '{{._webservice_secret}}',
  'token' => '{{._webservice_token}}'
];
$request = new Request('GET', 'https://dev3.nochalks.com/student?student_id=4&document=000.000.000-00&document_type=CPF', $headers);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();


				
			

Response (Respostas)

- Aluno encontrado (Status: 200)

				
					{
    "message": "Aluno Encontrado",
    "status": "200",
    "data": {
        "id": "1",
        "document_type": "CPF",
        "document": "999.999.999-99",
        "profile": {
            "instagram": "http:\/\/instagram.com\/aluno2",
            "facebook": "http:\/\/facebook.com\/aluno2",
            "twitter": null,
            "linkedin": null,
            "website": "http:\/\/mywebsite.com\/aluno2",
            "picture": ""
        },
        "geographic_lock": "0",
        "user": {
            "name": "aluno0",
            "email": "aluno0owner@nochalks.com.br",
            "expires_at": null
        },
        "secondaries": [
            {
                "name": "aluno0",
                "email": "aluno0secondary@nochalks.com.br",
                "expires_at": null
            }
        ],
        "form": null
    }
}
				
			
ESCOLHA UM ATENDIMENTO:
Contato por Chat CHAT
Contato por E-mail E-MAIL
Contato por Telefone TELEFONE
Contato por Whatsapp WHATSAPP