Aqui explicamos tudo sobre (nossa) API com alguns exemplos interessantes, como você pode usá-la e por que deve usá-la.

API significa Interface de Programação de Aplicativos. É a interface que permite que aplicativos de software se comuniquem entre si. Basicamente, ela permite que você solicite algo ou faça uma pergunta; em seguida, a chamada à API executa a ação que deve realizar, após você ter fornecido as informações necessárias.

Imagine que você está sentado à mesa de um restaurante com um cardápio de opções para pedir. A cozinha é a parte do “sistema” que preparará seu pedido. O que falta é o elo essencial para comunicar seu pedido à cozinha e entregar sua refeição de volta à sua mesa. É aí que entra o garçom, ou API. O garçom é o mensageiro – ou API – que recebe sua solicitação ou pedido e informa à cozinha – o sistema – o que fazer. Em seguida, o garçom entrega a resposta a você; nesse caso, trata-se da comida.

Resumindo, quando uma empresa oferece uma API aos seus clientes, isso significa apenas que ela criou um conjunto de URLs dedicadas que retornam respostas de dados puros — ou seja, as respostas não conterão o tipo de sobrecarga de apresentação que você esperaria em uma interface gráfica de usuário, como um site.

Temos cinco chamadas de API que cumprem funções diferentes.

Uma chamada de API consiste em três elementos:

A carga útil é a informação enviada a um endpoint, ou seja, os dados necessários para adicionar um participante.

O endpoint é um endereço da web para o qual as informações são enviadas, e a resposta indica se a chamada de API foi bem-sucedida ou não.

Os webhooks podem ser usados em conjunto com chamadas de API para iniciar diferentes ações. Quando um webhook é enviado contendo a carga útil necessária para que uma determinada chamada de API funcione, a chamada de API executa sua tarefa e adiciona o participante. Os webhooks devem ser enviados do seu sistema para o nosso endpoint e precisam ser configurados por você mesmo no seu sistema.

Os parágrafos a seguir fazem parte de um caso de uso fictício para explicar como webhooks e APIs podem funcionar juntos.

Um gerente de RH criou um curso básico e uma prova para funcionários recém-contratados. O gerente de RH deseja que os funcionários façam o curso, mas só quer que eles tenham acesso à prova após concluí-lo. Somente após serem aprovados na prova é que ele deseja que os funcionários tenham acesso à academia, que contém cursos e provas de nível intermediário e avançado. Então, como fazer essa configuração?

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

O gerente de RH precisa criar um webhook que envie uma carga útil para a API da prova depois que o funcionário concluir o curso. Esse webhook precisa conter apenas os dados necessários para acionar a chamada da API da prova. Nesse caso, usamos a chamada de API “Adicionar participante à prova (convite) ”. Quando esse webhook for enviado, a chamada de API será acionada se houver uma resposta de sucesso. A chamada de API adiciona o participante e envia o convite para a prova automaticamente.

O segundo webhook que o gerente de RH deve criar é para quando o funcionário for aprovado na prova e, assim, obter acesso à academia. Novamente, a carga útil desse webhook deve conter apenas as informações de que a chamada de API da academia precisa para adicionar o participante e enviar um convite. Após o envio desse webhook, a chamada de API da academia será acionada, e em seguida ela adicionará o participante à academia e enviará um convite.

Resumindo:

Um cliente deseja usar nossa ferramenta para treinar seus (novos) funcionários. Atualmente, ele usa a configuração “Um grupo predefinido de participantes” para enviar e-mails de convite. No entanto, muitos funcionários consideram esses convites como spam, e alguns desses e-mails também acabam indo para suas pastas de spam. O cliente deseja enviar esses convites a partir de seu próprio sistema.

Primeiro, o cliente cria um webhook que envia uma carga útil para a API de Prova — “adicionar participante sem notificação”. Quando um novo funcionário é adicionado ao seu sistema, o webhook envia a carga útil para a API da Prova, que adiciona o funcionário. A chamada à API não envia um convite a esse funcionário. Quando a chamada à API é bem-sucedida, a resposta inclui as credenciais de login. Essas credenciais de login devem então ser enviadas ao funcionário a partir do seu próprio sistema e do seu aplicativo de e-mail.

Isso também funciona para funcionários já existentes; basta criar um webhook que envie uma carga útil para a API da Prova, o que aciona a ação de adicionar participantes sem notificação à Prova. As credenciais de login retornadas na resposta da chamada à API podem então ser enviadas a partir do seu próprio sistema.

Um cliente cria provas em nosso sistema e as vende para seus próprios clientes por meio de seu site de comércio eletrônico. Ele deseja automatizar esse processo após os clientes pagarem por uma prova.

Para automatizar o processo de vendas, ele precisará usar um webhook. Quando seus clientes compram ou pagam por uma prova em seu site de comércio eletrônico, eles são adicionados ao sistema. O webhook criado deve ser acionado após o pagamento. Esse webhook enviará então a carga útil relevante para a chamada da API da prova e deve retornar uma resposta de sucesso ou de erro. Se for uma resposta de sucesso, a chamada da API adiciona e convida os clientes para a prova pelo qual pagaram.
​

Nossa API aceita application/x-www-form-urlencoded, multipart/form-data e JSON.

Saiba mais nos artigos a seguir: