Gerenciando seus alunos via API
Nesse artigo vamos te mostrar como é fácil integrar a Thinkr a algum outro sistema utilizando nossa API, para realizar cadastro e edição dos seus alunos.
Passo a passo para configuração
1 - Gerando chaves da API
Com seu usuário administrador acesse o menu Configurações > Chaves API. Nessa área você terá acesso as chaves já geradas, ou poderá criar uma nova. Todo registro é composto de Key e Secret, utilizaremos essas duas informações a diante.
2 - Configurando cabeçalho da integração
Ao todos são 3 informações que devem ser passadas no header da requisição, são elas:
3 - Configurando o corpo da requisição
A nossa API permite que 16 informações sejam alteradas ao todo, para um determinado aluno:
Para a edição, somente é necessário informar as colunas que deseja alterar, já para o cadastro são necessários dados de acordo com a “quantidade de etapas” configurada em seu ambiente.
Caso esteja habilitado o cadastro em 1 etapa, são necessários os dados abaixo:
Para o cadastro em 2 etapas, são necessários apenas:
Você pode alterar ou validar as etapas em Configurações > Gerais > aba Dados avançados.
4 - Tipos de requisição
É possível você tanto editar quando adicionar alunos via API. A diferença se dá no tipo de requisição que você fará para o mesmo endpoint:
POST - Cadastro de um aluno.
PUT - Edição de um aluno.
5 - Endpoint
Como dito acima, um só endpoint irá receber os dois tipos de requisição, de acordo com seu tipo, tentará adicionar ou editar um aluno:
As 5 etapas citadas acima compõem os passos para uma só requisição, ou seja, todos os passos devem ser seguidos para adicionar ou editar um aluno
Exemplo de uso
Cadastrando um aluno via cURL com cadastro em 2 etapas habilitado:
Editando somente nome e email de um aluno via cURL:
Em caso de dúvidas, não esqueça de nos contactar, seja pelo chat presente na plataforma ou via chamado enviando email para [email protected].
