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
Autenticação

Autenticação

A autenticação é necessária para acessar os recursos da API. Você deve incluir um token de acesso válido em todas as solicitações. Siga as etapas abaixo para obter um token de acesso:

Route (Rota)

Método Rota Descrição
POST /webservice/generate-token Retorna o webservice_token, necessário para todas as requisições

Header (Cabeçalho)

Param Tipo Descrição Obrigatório
Accept String application/json Não

Query Params (Requisição)

Param Tipo Descrição Obrigatório
webserviceSecret String *Secret Key do usuário Sim
webserviceUnique String **Unique key do usuário Sim

*Obtenção da Secret Key:

  • Acesse a plataforma e faça login na sua conta.
  • No menu principal, navegue até a seção de Usuários.
  • Abra a área dedicada ao Webservice e crie um novo usuário específico para a API.
  • Depois de criar o usuário, você receberá a Secret Key associada a esse usuário. Mantenha essa chave em um local seguro, pois você a usará para autenticar as requisições.

**Para conseguir a Unique Key entre em contato com nosso time de suporte.

Exemplos de Código

cURL


curl --location --globoff 'https://dev3.nochalks.com/generate-token?webserviceSecret={webservice_secret}&webserviceUnique={webservice_unique}' \
--header 'Accept: application/json'

Node.js


const axios = require('axios');
let data = JSON.stringify({
  "plans": [
    1,
    4
  ],
  "students": [
    2
  ]
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://dev3.nochalks.com/webservice/plans/disable-plans-to-students',
  headers: {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'secret': '{{._webservice_secret}}',
    'token': '{{._webservice_token}}'
  },
  data : data
};

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

PHP


 'application/json',
  'Accept' => 'application/json',
  'secret' => '{{._webservice_secret}}',
  'token' => '{{._webservice_token}}'
];
$body = '{
  "plans": [
    1,
    4
  ],
  "students": [
    2
  ]
}';
$request = new Request('POST', 'https://dev3.nochalks.com/webservice/plans/disable-plans-to-students', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

Resposta

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

{
    "message": "Token de autenticação gerado com sucesso!",
    "status": "200",
    "data": {
        "webservice_token": ""
    }
}