API

O que é uma API

API é um conjunto de rotinas e padrões de programação para acesso a um aplicativo de software ou plataforma baseado na Web. A sigla API refere-se ao termo em inglês "Application Programming Interface" que significa em tradução para o português "Interface de Programação de Aplicativos".

Uma API é criada quando uma empresa de software tem a intenção de que outros criadores de software desenvolvam produtos associados ao seu serviço. Existem vários deles que
disponibilizam seus códigos e instruções para serem usados em outros sites da maneira mais conveniente para seus usuários. O Google Maps é um dos grandes exemplos na área de APIs. Por meio de seu código original, muitos outros sites e aplicações utilizam os dados dele adaptando-o da melhor forma a fim de utilizar esse serviço.
É através da API que você integra o seu sistema ao EAD com algum outro sistema. Além disso, você também pode recriar as funcionalidades existentes na plataforma consumindo a API.

Para visualizar a documentação completa da API, veja esse link.

🚧

Importante

Esse recurso está disponível a partir do plano Essentials 30GB.

Nossa API é RESTful , significa que qualquer linguagem de programação se conecta a ela, e todas as suas respostas são em JSON , no endpoint base:

https://dominio-do-ead/api/1/

Dentro da sua plataforma também existe a documentação original de fácil acesso. Para acessar a API, siga os passos:

1- Clique em "Administrar":

2- Clique em "Menu" > "Configurações":

3- Clique em "Menu" > "API":

4- Você verá a seguinte tela:

5. Copie o token para colar na Sandbox e clique no link *Documentação API.

6. Na página da documentação você terá acesso as seguintes rotas:

▸ Usuários
▸ Permissões
▸ Categorias de Cursos
▸ Cursos
▸ Depoimentos
▸ Banco de Questões
▸ Boletim do Aluno
▸ Biblioteca
▸ Log de acesso e Progresso do aluno
▸ Certificados
▸ Matrículas
▸ Grupos
▸ Planos
▸ Assinaturas
▸ Cupons
▸ Carrinho
▸ Transações
▸ Cobranças