Pular para o conteúdo

nochalks

Menu
Começando
Autenticação
Aluno
Link para login externo Deletar vínculo de múltiplos planos a múltiplos alunos Desativar vínculos de múltiplos planos a múltiplos alunos Vincular múltiplos planos a múltiplos alunos Criar Vários Alunos Incluir Aluno a uma Turma Resetar senha do Aluno Expirar acesso do Aluno Ativar/Desativar Alunos Vincular plano ao Aluno Ativação do plano do Aluno Bloqueio Geográfico para Aluno Consultar Turmas do Aluno Consultar Planos do Aluno Consultar Aluno Criar Aluno
Bloqueio Geográfico
Desbloquear Região Bloquear Região Listar regiões com acesso bloqueado Bloqueio Geográfico para Aluno
Planos
Listar Planos
Consultar Aluno

Consultar Aluno

Para consultar os dados de um aluno na sua plataforma, utilize a rota abaixo.

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

Exemplos de Código

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


 '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();
?>

Resposta

Status: 200
Mensagem: Aluno Encontrado
Resposta: 

{
    "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": "[email protected]",
            "expires_at": null
        },
        "secondaries": [
            {
                "name": "aluno0",
                "email": "[email protected]",
                "expires_at": null
            }
        ],
        "form": null
    }
}