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
Criar Aluno

Criar Aluno

Para registrar um novo aluno na plataforma, utilize os parâmetros abaixo para o corpo da requisição.

Route (Rota)

Método Rota Descrição
POST /webservice/student/create Faz o registro de um novo aluno na plataforma

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.

Body Params (Parâmetros)

Param Tipo Descrição Obrigatório
name String Nome do aluno Sim
document_type String *Tipo de documento - Ex.: CPF Sim
document String Documento do aluno - Ex.: XXX.XXX.XXX-XX Sim
email String E-mail do aluno Sim
password String Senha do aluno Sim
password_confirmation String Repetir senha do aluno Sim
language String **Idioma do aluno - Ex.: br Não
address JSON Endereço do aluno Não
address.location JSON JSON com o endereço do aluno Não
address.location.zip String Código postal do aluno - Ex.: XXXXX-XXX Não
address.location.address String Endereço/Logradouro - Ex.: Rua 1 Não
address.location.number String Número do endereço do aluno Não
address.location.neighborhood String Bairro do aluno - Ex.: Centro Não
address.location.country String País do endereço do aluno Não
address.location.state String UF do endereço aluno - Ex.: MG Não
address.location.city String Cidade do endereço do aluno Não
address.location.info String Informações complementares - Ex.: AP 101 Não
address.location.code String Código do país do endereço - Ex.: BR Não

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

** Os idiomas padrões disponíveis na plataforma são: “br” e “en”

Exemplos de Código

cURL


curl --location 'https://dev3.nochalks.com/student/create' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'secret: {{ _.webservice_secret }}' \
--header 'token: {{ _.webservice_token }}' \
--data-raw '{
  "name": "API Aluno 1",
  "email": "[email protected]",
  "password": "111111"
}'

Node.js


const axios = require('axios');
let data = JSON.stringify({
  "name": "API Aluno 1",
  "email": "[email protected]",
  "password": "111111"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://dev3.nochalks.com/student/create',
  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 = '{
  "name": "API Aluno 1",
  "email": "[email protected]",
  "password": "111111"
}';
$request = new Request('POST', 'https://dev3.nochalks.com/student/create', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
?>

Request (Requisição)


{
    "name": "Nome do Aluno",
    "document_type": "CPF",
    "document": "xxx.xxx.xxx-xx",
    "email": "[email protected]",
    "password": "123456",
    "password_confirmation": "123456",
    "language": "br",
    "address": {
        "location": {
            "zip": "12345-123",
            "address": "Rua",
            "number": "10",
            "neighborhood": "Bairro",
            "country": "Brasil",
            "code": "BR",
            "state": "MG",
            "city": "Cidade",
            "info": "Apartamento"
        }
    }
}

Response (Respostas)

Status: 200
Mensagem: Conta criada com sucesso!
Resposta: 

{
  "message": "Conta criada com sucesso!"
}