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.

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:

key : key gerada da etapa 1
secret: secret gerada na etapa 1
Content-Type: application/x-www-form-urlencoded

3 - Configurando o corpo da requisição

Devem ser informados na estrutura abaixo o CPF, o curso e o status da matrícula desejada:

{
  "Matricula": [
    {
      "cpf""99999999999",
      "curso_id"100,
      "status""Matriculado"
    },
    {
      "cpf""88888888888",
      "curso_id"101,
      "status""Matriculado"
    }
  ]
}

Os possíveis status para matrícula são:

  • Matriculado

  • Cancelada

4 - Tipos de requisição

É possível você tanto editar quando gerar matrículas via API, a diferença se da no tipo de requisição que você fará para o mesmo endpoint:

  • POST - Gerar uma nova matrícula

  • PUT - Editar uma matrícula já existente

5 - Endpoint

Como dito acima, um só endpoint irá receber os dois tipos de requisição, de acordo com seu tipo, tentará gerar ou editar uma matrícula:

http://SEU_DOMINIO_THINKR/api/v1/matriculas

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

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'

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]

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