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
Link para Login Externo

Link para Login Externo

Para login externo na sua plataforma deve-se primeiro criar o auth-token e em seguida usar o mesmo no link de login externo via Query Params.

Route (Rota)

Método Rota Descrição
POST webservice/student/{{student_id}}/create-auth-token Gera o auth-token referente ao aluno
GET webservice/authenticate/{{auth_token}} Link para login

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.

Query Params (Parâmetros)

Param Tipo Descrição Obrigatório
plan String Adicionar o id de um plano no juntamente ao criar um auth_token direciona o aluno logado diretamente para página do plano Não

Exemplos de Código

cURL


curl --location --globoff --request POST 'https://dev3.nochalks.com/webservice/student/{{student_id}}/create-auth-token' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'secret: {{ _.webservice_secret}}' \
--header 'token: {{ _.webservice_token}}'

Node.js


const axios = require('axios');

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://dev3.nochalks.com/webservice/student/{{student_id}}/create-auth-token',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json;charset=UTF-8',
    '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',
  'Content-Type' => 'application/json;charset=UTF-8',
  'secret' => '{{ _.webservice_secret}}',
  'token' => '{{ _.webservice_token}}'
];
$body = '';
$request = new Request('POST', 'https://dev3.nochalks.com/webservice/student/{{student_id}}/create-auth-token', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
?>

Resposta

Status: 200
Mensagem: Token de autenticação gerado com sucesso!
Resposta: 

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZW1haWwiOiJhbHVub3Rlc3RlMDFAZW1haWwuY29tIiwiZXhwIjoxNjkxMDc5MzQzfQ.Ws9a-IA5RMGH9mA-wC2y4SLtlm-fc3F04XnkkMkf7AU"
}