Base de Conhecimento

Voltar

Gerenciando matrículas via API


Nesse artigo vamos te mostrar como é fácil integrar o Thinkr a algum outro sistema utilizando nossa API, para realizar ou cancelar matrículas, afinal nosso propósito é simplificar a gestão e acompanhamento dos seus alunos, então nada de trabalho manual.

Este artigo estará dividido basicamente nas seguintes etapas:

Você tem todos os detalhes na colletion do Postman disponibilizada clicando aqui.

Geração das chaves 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 por um nome identificador mas apenas para referência e uma key e secret gerados automaticamente.

Realizando uma matrícula

Para toda ação de matrícula, será necessário enviar um cabeçalho contendo os dados gerados na etapa anterior, além da estrutura contendo o curso, CPF do aluno e o status "Matriculado". 

O retorno da requisição irá te disponibilizar um resumo da situação das matrículas, pois é possível fazer uma requisição para um CPF ainda indisponível e ele ser adicionar por exemplo em uma "fila de espera".

Endpoint: https://seu_dominio_thinkr/api/v1/matriculas

Método: POST

Atualizando uma matrícula

Além da estrutura disponível na matrícula, na atualização é possível informar uma data de expiração da sua matrícula opcionalmente, diferente do já configurado no curso. Caso não seja informado a "data_expiracao", será considerado para a matrícula, a configuração do curso.

Também é possível cancelar uma matrícula já existente, para isso basta enviar o status "Cancelada".

Endpoint: https://seu_dominio_thinkr/api/v1/matriculas

Método: PUT

Exemplo de uso

Gerando uma matrícula:

curl --location --request POST 'https://SEU_DOMINIO_THINKR/api/v1/matriculas' \
--header 'key: xxxxxxxxxxxxxx' \
--header 'secret: xxxxxxxxxxxxxx' \
--data-urlencode 'Matricula[0][cpf]=99999999999' \
--data-urlencode 'Matricula[0][curso_id]=100' \
--data-urlencode 'Matricula[0][status]=Matriculado'

Alterando uma matrícula via cURL:

curl --location --request PUT 'https://SEU_DOMINIO_THINKR/api/v1/matriculas' \
--header 'key: xxxxxxxxxxxxxx' \
--header 'secret: xxxxxxxxxxxxxx' \
--data-urlencode 'Matricula[0][cpf]=99999999999' \
--data-urlencode 'Matricula[0][curso_id]=100' \
--data-urlencode 'Matricula[0][status]=Matriculado' \
--data-urlencode 'Matricula[0][data_expiracao]=2020-02-02'

Em caso de dúvidas, não esqueça de nos contatar, seja pelo chat presente na plataforma ou via chamado enviando email para [email protected].

Artigos complementares:

Nós usaremos cookies para melhorar e personalizar sua experiência.