Resetar senha do Aluno

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

cURL

				
					curl --location --request POST 'https://sua.plataforma.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

PHP

				
					<?php
$client = new Client();
$headers = [
  'Accept' => '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();

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

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://sua.plataforma.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);
});

Request (Requisição)

- Request com ID do Aluno

				
					{
	"student_id": 3,
	"expires_at": "2023-01-31"
}

- Request com Documento do Aluno

				
					{
	"document_type": "cpf",
	"document": "999.999.999-99",
	"expires_at": "2023-01-31"
}

Response (Respostas)

- Atualizado (Status: 200)

				
					{
    "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": "teste@teste.com",
            "expires_at": "2023-01-31"
        },
        "secondaries": [],
        "form": null
    }
}