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
Resetar Senha do Aluno

Resetar Senha do Aluno

Para resetar a senha do aluno, utilize a rota abaixo. O processo de reset envolve a expiração da senha e envio de um e-mail para o aluno criar uma nova senha.

Route (Rota)

Método Rota Descrição
PUT /webservice/student/password/forgot Determina uma data para que a senha do aluno expire e envia um e-mail para criar uma nova senha.

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
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
expires_at String **Data que a senha do Aluno irá expirar (Ex: 2022-01-30) Não

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

** Formato da data: AAAA-MM-DD

Exemplos de Código

cURL


curl --location --request POST 'https://dev3.nochalks.com/student/password/forgot?student_id=1&document=document91&document_type=document_type91&expires_at=2022-07-04' \
--header 'Accept: application/json' \
--header 'secret: {{._webservice_secret}}' \
--header 'token: {{._webservice_token}}'

Node.js


const axios = require('axios');
let data = '';

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://dev3.nochalks.com/student/password/forgot?student_id=1&document=document91&document_type=document_type91&expires_at=2022-07-04',
  headers: {
    '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',
  'secret' => '{{._webservice_secret}}',
  'token' => '{{._webservice_token}}'
];
$body = '';
$request = new Request('POST', 'https://dev3.nochalks.com/student/password/forgot?student_id=1&document=document91&document_type=document_type91&expires_at=2022-07-04', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
?>

Exemplo de Request e Response

Status: 200
Mensagem: Atualizado
Resposta: 

{
    "message": "Atualizado",
    "status": 200,
    "data": {
        "id": 1,
        "document_type": "CPF",
        "document": "999.999.999-99",
        "geographic_lock": 1,
        "profile": {
            "instagram": null,
            "facebook": null,
            "twitter": null,
            "linkedin": null,
            "website": null,
            "picture": null
        },
        "user": {
            "name": "Teste",
            "email": "[email protected]",
            "expires_at": "2023-01-31"
        },
        "secondaries": [],
        "form": null
    }
}