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 Turmas do Aluno

Consultar Turmas do Aluno

Route (Rota)

Método Rota Descrição
GET /webservice/student/classrooms Retorna o aluno e as turmas vinculadas a ele

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
filter JSON JSON com filtros a serem aplicados as turmas do aluno Não
field_name String Não
field_value String 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/classrooms?document=1&document_type=rg' \
--header 'Accept: application/json' \
--header 'secret: {{._webservice_sercret}}' \
--header 'token: {{._webservice_token}}'

Node.js


const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://dev3.nochalks.com/student/classrooms?document=1&document_type=rg',
  headers: {
    'Accept': 'application/json',
    'secret': '{{._webservice_sercret}}',
    'token': '{{._webservice_token}}'
  }
};

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

PHP


 'application/json',
  'secret' => '{{._webservice_sercret}}',
  'token' => '{{._webservice_token}}'
];
$request = new Request('GET', 'https://dev3.nochalks.com/student/classrooms?document=1&document_type=rg', $headers);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
?>

Resposta (Respostas)

Status: 200
Mensagem: Aluno encontrado
Resposta: 

{
    "message": "Encontrado",
    "status": "200",
    "data": {
        "student": {
            "id": "1",
            "document_type": "CPF",
            "document": "999.999.999-99",
            "geographic_lock": "0",
            "profile": {
                "instagram": null,
                "facebook": null,
                "twitter": null,
                "linkedin": null,
                "website": null,
                "picture": null
            },
            "user": {
                "name": "User",
                "email": "[email protected]",
                "expires_at": null
            },
            "secondaries": [],
            "form": null
        },
        "classrooms": [
            {
                "id": "1",
                "status": "1",
                "author": {
                    "id": "1",
                    "name": "author",
                    "email": "[email protected]",
                    "language": "br"
                },
                "translation": {
                    "name": "Turma",
                    "description": "
Turma de Teste<\/p>"
                }
            }
        ]
    }
}