Criar Vários Alunos

Route (Rota)

Método Rota Descrição
POST /webservice/student/create-many 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
email String E-mail do aluno Sim
password String Senha do aluno Sim
document_type String *Tipo de documento - Ex.: CPF Não
document String Documento do aluno - Ex.: XXX.XXX.XXX-XX Não
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

cURL

				
					curl --location 'https://dev3.nochalks.com/webservice/student/create-many' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'secret: {{ _.webservice_secret }}' \
--header 'token: {{ _.webservice_secret }}' \
--data-raw '{
  "students": [
    {
      "name": "API Aluno 2",
      "email": "api2@email.com",
      "password": "222222"
    },
    {
      "name": "API Aluno 3",
      "email": "api3@email.com",
      "password": "333333"
    },
    {
      "name": "API Aluno 4",
      "email": "api4@email.com",
      "password": "444444"
    },
    {
      "name": "API Aluno 1",
      "email": "api1@email.com",
      "password": "1111111"
    }
  ]
}'
				
			

Node.js

				
					const axios = require('axios');
let data = JSON.stringify({
  "students": [
    {
      "name": "API Aluno 2",
      "email": "api2@email.com",
      "password": "222222"
    },
    {
      "name": "API Aluno 3",
      "email": "api3@email.com",
      "password": "333333"
    },
    {
      "name": "API Aluno 4",
      "email": "api4@email.com",
      "password": "444444"
    },
    {
      "name": "API Aluno 1",
      "email": "api1@email.com",
      "password": "1111111"
    }
  ]
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://dev3.nochalks.com/webservice/student/create-many',
  headers: { 
    'Content-Type': 'application/json', 
    'Accept': 'application/json', 
    'secret': '{{ _.webservice_secret }}', 
    'token': '{{ _.webservice_secret }}'
  },
  data : data
};

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

				
			

PHP

				
					<?php
$client = new Client();
$headers = [
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'secret' => '{{ _.webservice_secret }}',
  'token' => '{{ _.webservice_secret }}'
];
$body = '{
  "students": [
    {
      "name": "API Aluno 2",
      "email": "api2@email.com",
      "password": "222222"
    },
    {
      "name": "API Aluno 3",
      "email": "api3@email.com",
      "password": "333333"
    },
    {
      "name": "API Aluno 4",
      "email": "api4@email.com",
      "password": "444444"
    },
    {
      "name": "API Aluno 1",
      "email": "api1@email.com",
      "password": "1111111"
    }
  ]
}';
$request = new Request('POST', 'https://dev3.nochalks.com/webservice/student/create-many', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

				
			

Request (Requisição)

				
					{
    "name": "Nome do Aluno",
    "email": "email@email.com",
    "password": "123456",
    "document_type": "CPF",
    "document": "xxx.xxx.xxx-xx",
    "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)

- Resposta ao criar um novo aluno (Status: 200)

				
					{
  "message": "Conta criada com sucesso!"
}
				
			
ESCOLHA UM ATENDIMENTO:
Contato por Chat CHAT
Contato por E-mail E-MAIL
Contato por Telefone TELEFONE
Contato por Whatsapp WHATSAPP