Central de Suporte

Introdução à API de Integração da Eadbox

Importante: Este artigo trata de informações técnicas relacionadas à programação. Para realizar integrações utilizando a nossa API de integração, é essencial ter conhecimentos de programação, especialmente relacionados ao protocolo de comunicação HTTP.

 

A API da Eadbox oferece inúmeras possibilidades de integração com todo tipo de sistema - desde o seu site institucional, até um CRM, ERP ou sistema acadêmico. Mas para que você possa integrar nossa plataforma com algum outro sistema, é necessário que este sistema possa ser configurado ou personalizado para receber/enviar informações quando preciso. Esta demanda varia muito de negócio para negócio, então caso queira analisar a viabilidade de uma integração, sinta-se à vontade para entrar em contato com nossa equipe técnica - ou, caso já seja cliente, com o seu gerente de sucesso! ;)

Por onde começar?

Você deve possuir, para referência, acesso à Documentação de nossa API (está anexa a este artigo). Com ela, você entenderá os formatos dos métodos que estão disponíveis para consumo, bem como qual o tipo da requisição HTTP que deve ser enviada, e qual a URL da mesma. Todos os caminhos assumem que já estará sendo acessada a url /api a partir da raiz da plataforma.

Outras ferramentas úteis são o Postman ou o curl, que permitem testar os métodos de forma isolada e facilmente replicável antes de codificar a integração em sua forma final - recomendamos sempre validar os requisitos da integração desta forma.

Consumindo os métodos da API

Um dos métodos mais importantes da API é o 2.2 (/login). Isto se deve ao fato dele retornar, em caso de sucesso, o auth_token do usuário autenticado, que pode ser utilizado para iniciar uma sessão na plataforma com o perfil do usuário informado. Desta forma, o navegador pode ser direcionado para uma página já logado, ou ainda podem ser chamados outros métodos da API a serem executados utilizando este usuário. Segue um exemplo utilizando o Postman:

O retorno da execução deste método é o seguinte:

Como pode ser observado neste exemplo, em caso de sucesso o método retorna o auth_token do usuário logado, fazendo com que seja possível acessar páginas ou executar outros métodos usando seu perfil.

 

Para obter as informações referentes às matrículas que este usuário possui utilizando a API, por exemplo, podemos utilizar o método 3.1 (/user/subscriptions), da seguinte forma (observe que o auth_token pode ser passado como um parâmetro, diretamente na URL da requisição):

A execução do método acima retorna um JSON análogo a este (as informações aninhadas em "course" foram ocultadas para facilitar a visualização):

Outro exemplo usual é direcionar este usuário para a página que contém os cursos no qual ele está matriculado como aluno. Para fazer isso, basta redirecionar o navegador para:

https://apresentacao.eadbox.com/student/courses?auth_token=wNEGyV9PaYtkzoBgKuxF

Métodos de Administrador

Os métodos listados na seção 4 de nossa API são restritos a usuários com perfil de administrador somente. Para fazer isto, basta utilizar o método 2.2 (/login) para obter um auth_token de administrador, e então informá-lo como parâmetro nas requisições desejadas.

É comum que seja criado um usuário do grupo Administrador exclusivamente para uso nas integrações que requerem este tipo de permissão. Esta é uma boa prática que recomendamos, pois facilita a identificação de operações indevidas realizadas por uma integração, por exemplo, além de facilitar medidas de segurança como por exemplo a auditoria dos endereços de IP a partir dos quais os administradores iniciam suas sessões.

Tem mais dúvidas? Envie uma solicitação

Comentários

Powered by Zendesk