Aqui explicamos tudo sobre a (nossa) API com alguns bons exemplos, como a pode utilizar e porque a deve utilizar.

API significa Interface de Programação de Aplicações. É a interface que permite que as aplicações de software comuniquem entre si. Basicamente, permite-lhe pedir algo ou fazer uma pergunta, após o que a chamada à API executa a ação que é suposto fazer, depois de lhe ter fornecido informações.

Imagine que está sentado à mesa de um restaurante com um menu de opções para encomendar. A cozinha é a parte do "sistema" que irá preparar o seu pedido. O que falta é o elo crítico para comunicar o seu pedido à cozinha e entregar a comida na sua mesa. É aí que entra o empregado de mesa, ou API. O empregado de mesa é o mensageiro - ou API - que recebe o seu pedido ou encomenda e diz à cozinha - o sistema - o que fazer. Em seguida, o empregado de mesa devolve a resposta ao cliente; neste caso, é a comida.

Resumindo, quando uma empresa oferece uma API aos seus clientes, isso significa apenas que construiu um conjunto de URLs dedicados que devolvem respostas de dados puros - o que significa que as respostas não contêm o tipo de sobrecarga de apresentação que seria de esperar numa interface gráfica de utilizador como um website.

Temos cinco chamadas API que servem diferentes funções.

Uma chamada API consiste em três coisas:

O payload é a informação que é enviada para um endpoint, ou seja, os dados necessários para adicionar um participante.

O endpoint é um endereço Web para o qual a informação é enviada e a resposta indica se a chamada à API foi bem sucedida ou não.

Os webhooks podem ser utilizados em conjunto com as chamadas à API para iniciar diferentes acções. Quando é enviado um webhook que contém o payload necessário para que uma determinada chamada de API funcione, a chamada de API fará o seu trabalho e adicionará o participante. Os webhooks têm de ser enviados do seu sistema para o nosso endpoint e têm de ser configurados no seu sistema.

Os parágrafos seguintes fazem parte de um caso de utilização fictício para explicar como os webhooks e as APIs podem funcionar em conjunto.

Um diretor de RH criou um curso e uma prova de nível de entrada para os funcionários recém-contratados. O gestor de RH quer que os funcionários façam o curso, mas só quer que eles tenham acesso à prova depois de concluírem o curso. Só depois de passarem no exame é que querem que os empregados tenham acesso à academia, que contém cursos e provas de nível intermédio e especializado. Então, como é que isto se configura?

Para entender como configurar isto, já estabelecemos que estes webhooks e chamadas API serão enviados internamente dentro do sistema Easy LMS. O processo é o seguinte.

O gestor de RH tem de criar um webhook que envia um payload para a API de provas depois de o empregado concluir o curso. Este webhook só tem de conter os dados necessários para acionar a chamada à API de provas. Neste caso, utilizamos a chamada da API Adicionar participante à Prova (convite). Quando este webhook tiver sido enviado, a chamada à API será acionada se houver uma resposta de sucesso. A chamada da API adiciona o participante e envia o convite para a prova automaticamente.

O segundo webhook que o gestor de RH deve criar é para quando o empregado passa na prova com sucesso para ter acesso à academia. Novamente, o payload desse webhook deve conter apenas as informações que a chamada à API da academia precisa para adicionar o participante e enviar um convite. Depois de enviar esse webhook, a chamada da API da academia será acionada e, em seguida, adicionará o participante à academia e enviará um convite.

Para resumir:

Um cliente pretende utilizar a nossa ferramenta para formar os seus (novos) empregados. Atualmente, utilizam a definição Um grupo predefinido de participantes para enviar e-mails de convite. No entanto, muitos funcionários consideram estes convites como spam, e alguns destes e-mails também acabam nas suas pastas de spam. O cliente pretende enviar estes convites a partir do seu próprio sistema.

O cliente cria primeiro um webhook que envia uma carga útil para a API Provas - adicionar participante sem notificar. Quando um novo funcionário é adicionado ao seu sistema, o webhook envia o payload para a API de provas que adiciona o funcionário. A chamada à API não envia um convite a este funcionário. Quando a chamada à API é bem sucedida, a resposta inclui credenciais de início de sessão. Estas credenciais de início de sessão devem então ser enviadas ao funcionário a partir do seu próprio sistema e aplicação de correio eletrónico.

Isto também funciona para os empregados existentes, basta criar um webhook que envia uma carga para a API de provas que desencadeia a ação de adicionar participantes sem notificar a prova. As credenciais de início de sessão devolvidas na resposta da chamada à API podem então ser enviadas a partir do seu próprio sistema.

Um cliente cria provas no nosso sistema e vende-as aos seus próprios clientes a partir do seu sítio Web de comércio eletrónico. Pretende automatizar este processo depois de os clientes pagarem por uma prova.

Para automatizar o processo de venda, é necessário utilizar um webhook. Quando os clientes compram ou pagam por uma prova no seu sítio Web de comércio eletrónico, são adicionados ao seu sistema. O webhook que eles criam deve ser ativado após o pagamento. Este webhook enviará então o payload relevante para a chamada API da prova e deverá devolver uma resposta de sucesso ou de erro. Se a resposta for positiva, a chamada à API adiciona e convida os clientes para a prova que pagaram.
​

A nossa API aceita application/x-www-form-urlencoded ou multipart/form-data e json.

Para mais informações, consulte os artigos seguintes: