Este artigo também está disponível em:
Aqui nós explicamos tudo sobre (nossa) API com alguns bons exemplos, como você pode usá-la, e porque você deve usá-la.

1. O que é API?

API significa Application Programming Interface. É a interface que permite que as aplicações de software se comuniquem entre si. Ela basicamente permite que você solicite algo, ou faça uma pergunta, após a qual a chamada da API executa a ação que é suposto fazer, depois que você a tenha fornecido com informações. Em nosso caso isto seria pedir para adicionar um participante a um exame, curso, ou à Academia, o que requer dados específicos sobre o participante.

Exemplo 1

Quando você vai para o Facebook no seu navegador, uma solicitação sai para o servidor remoto do Facebook. Quando o seu navegador recebe a resposta, ele interpreta o código e exibe a página.

Para o navegador, também conhecido como o cliente, o servidor do Facebook é uma API. Isso significa que toda vez que você visita uma página na Web, você interage com alguma API de servidor remoto.

Uma API não é a mesma que a remota  rather- rather é a parte do servidor que recebe solicitações e envia respostas.

Exemplo 2

Imagine que você está sentado em uma mesa em um restaurante com um cardápio de escolhas para pedir. A cozinha é a parte do "sistema" que irá preparar o seu pedido. O que está faltando é o elo crítico para comunicar seu pedido à cozinha e entregar sua comida de volta à sua mesa. É aí que entra o garçom ou API. O garçom é o mensageiro - ou API - que leva seu pedido ou pedido e diz à cozinha - o sistema - o que fazer. Então o garçom entrega a resposta de volta para você; neste caso, é a comida.

Para resumir, quando uma empresa oferece uma API para seus clientes, isso só significa que eles construíram um conjunto de URLs dedicadas que retornam dados puros responses - meaning 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 website.

2. Para que eu o uso?

Os desenvolvedores podem usar diferentes APIs de diferentes maneiras para construir coisas diferentes. O Facebook é um bom exemplo; o site lançou sua plataforma de desenvolvedores chamada F8 em maio e agora hospeda 10.900 aplicativos dos infames Scrabulous até mensagens instantâneas e jogos de luta de alimentos.

A vantagem para o site hospedeiro é que ele recebe muitos recursos novos e legais de graça, enquanto os desenvolvedores conseguem promover seu trabalho em um site mais conhecido e construir sobre o trabalho de outra pessoa. A maioria destas aplicações são construídas por empresas com seu próprio site - muitas vezes empresas menores com menos tráfego e que se beneficiam do "crossover". O site de análise de filmes Flixster, por exemplo, tem um aplicativo popular no Facebook, assim como o Last.fm e o site de compartilhamento de fotos Flickr.

3. Quais chamadas API o LMS Easy LMS tem?

O Easy LMS tem cinco chamadas API que atendem a diferentes funções:

Adicionar participante ao Exam (convidar)
Adicionar participante ao Exame sem notificação (sem convite)
Adicionar participante ao Curso (convidar)
Adicionar participante à Academy (convidar)
Adicionar participante à Academy sem notificação (sem convite)

A API chama para um Exame só funciona quando o acesso é definido para Um grupo predefinido de participantes, ou para um Curso que é apenas por convite. Isto é auto-explicativo para a Academia. Também não é possível usar qualquer uma destas chamadas para o mesmo Exame, Curso ou Academia quando um participante já tiver sido adicionado a ele. Isto porque o objetivo destas chamadas API é adicionar participantes, então se eles já foram adicionados, a chamada API não funciona.

Uma chamada API consiste em três coisas:

A carga útil (os dados reais que são enviados)
O endpoint (o endereço para o qual os dados são enviados)
A resposta (sucesso ou resposta de erro)

A carga útil é a informação que é enviada para um ponto final, o que significa que os dados são necessários para adicionar um participante ao exame, curso ou academia.

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.

4. Webhooks

Webhooks podem ser usados em conjunto com chamadas API para iniciar diferentes ações. Quando um webhook é enviado que contém a carga útil necessária para uma determinada chamada API funcionar, a chamada API fará seu trabalho e adicionará o participante. Os webhookks devem ser enviados de seu sistema para nosso endpoint. Isto é algo que você teria que configurar você mesmo em seu sistema.

Exemplo 1 - Curso, Exame, Academia

Os parágrafos seguintes são parte de um caso de uso fictício para explicar como os "webhooks" e API's podem trabalhar juntos.

Um gerente de RH criou um Curso e Exame de nível básico para funcionários recém-contratados. O gerente de RH quer que os funcionários façam o Curso, mas só quer que eles tenham acesso ao Exame após a conclusão do Curso. Somente após passar no Exame ele quer que os funcionários tenham acesso à Academia, que contém Cursos e Exames de nível intermediário e especializado. Então, como eles montam isto?

Para entender como configurar isso, nós já estabelecemos que esses ganchos web e chamadas API serão enviadas internamente dentro do sistema Easy LMS. O processo é o seguinte:

O gerente de RH tem que criar um webhook que envie uma carga horária para a API do exame depois que o funcionário completar o curso. Este webhook só tem que conter os dados necessários para acionar a chamada da API de exame. Neste caso, nós usamos o Adicionar participante ao Exam (convidar) API call. Quando este webhook for enviado, a chamada da API será acionada se houver uma resposta de sucesso. A chamada de API adiciona o participante e envia o convite para o Exame automaticamente.

O segundo webhook que o gerente de RH deve criar é para quando o funcionário passar com sucesso no exame para ter acesso à Academia. Novamente, este 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 este webhook "Exam passed", a chamada de API da Academia será acionada, após o que ele adiciona o participante e envia um convite para a Academia.

Para resumir:

Criar um webhook para a conclusão do Curso que é enviado para a chamada API do Exame.
Criar um gancho web para passar no Exame que é enviado para a chamada de API da Academia.
O funcionário faz o Curso e o completa.
O webhook para conclusão do Curso é enviado para Adicionar participante ao Exame (convidar) API call endpoint e adiciona e convida o participante para o Exame.
Empregado faz o Exame e passa.
O Webhook para passar no Exame é enviado para Adicionar participante à Academia (convidar) API call endpoint e adiciona e convida o participante para a Academia.



Exemplo 2 - Envio de convites a partir do seu próprio sistema

Um cliente quer usar nossa ferramenta para treinar seus (novos) funcionários. Eles atualmente usam o Um grupo predefinido de participantes configuração para enviar e-mails de convite. Entretanto, muitos funcionários percebem esses convites como spam, e alguns desses e-mails também acabam em suas pastas de spam. O cliente quer enviar estes convites a partir de seu próprio sistema ao invés disso.

O cliente primeiro cria um webhook que envia uma carga útil para a API do exame - adicionar participante sem notificar. Quando um novo funcionário é adicionado ao seu sistema, o webhook envia a carga útil para a API do exame que adiciona o funcionário. A chamada API não envia um convite a este funcionário. Quando a chamada da API é bem sucedida, a resposta inclui credenciais de login. Estas credenciais de login devem então ser enviadas ao funcionário a partir do seu próprio sistema e aplicação de e-mail.

Isto também funciona para os funcionários existentes, você só precisa criar um webhook que envie uma carga útil para a API do Exame que acione a ação de adicionar participantes sem notificar o Exame. As credenciais de login retornadas na resposta da chamada da API podem então ser enviadas a partir do seu próprio sistema.

Exemplo 3 - Exames de Venda

Um cliente cria Exames em nosso sistema e os vende para seus próprios clientes a partir de seu site de comércio eletrônico. Ele quer automatizar isto depois que seus clientes pagarem por um Exame.

Para automatizar seu processo de vendas, ele precisará usar um gancho para a web. Quando seus clientes compram ou pagam por um exame em seu site de comércio eletrônico, eles são adicionados ao seu sistema. O webhook que ele cria deve ser acionado depois que eles tiverem pago. Este webhook então enviará a carga útil relevante para a chamada API do Exame e deve retornar ou uma resposta de sucesso ou de erro. Se for uma resposta bem sucedida, a chamada de API adiciona e convida seus clientes para o Exame pelo qual eles pagaram.



5. Quando nós usamos cada uma das chamadas API e quais são as suas especificações?

Como cada chamada API tem uma função diferente, elas podem ser usadas para alcançar coisas diferentes. Por exemplo, Adicionar participante ao Exame (convite) pode ser usado para adicionar um participante e enviar um convite para um Exame automaticamente quando este gatilho for ativado.

Nossa API aceita aplicações/x-www-form-urlencoded ou multipart/form-data e json.

Saiba mais sobre nossas chamadas API para exames e academias em este artigo.

Saiba mais sobre nosso curso API call in este artigo.
Este artigo foi útil?
Cancelar
Obrigado!