Vamos então entender o que é a tão famosa API!

API, do inglês significa Application Protocol Interface ou Appliacction Programming Interface que traduzindo seria algo como “Interface de programação de aplicações”

Elas são mecanismos que permitem que dois sistemas distintos se comuniquem por meio de protocolos. Para ter uma ideia de como elas funcionam, precisamos trabalhar com cliente e servidor. Onde, o cliente vai solicitar algo, e o servidor vai dar uma resposta, referente ao que foi solicitado. Vamos pensar em termos práticos.

Exemplo prático

Sabe quando você está fazendo o cadastro em algum site, e ao digitar o seu CEP, ele preenche o restante dos dados de forma automática? Nesse caso, ao preencher o CEP o site faz uma conexão com o site do Correios para obter o restante das informações. Essa conexão, é feita por meio de uma API, que pega os dados e retorna para você terminar o preenchimento do endereço.

Ou até mesmo, quando você acessa o Google Maps, é possível visualizar alguns pontos específicos como shoppings, hospitais, universidades e hotéis. Eles estão lá independentes da sua busca. Essa integração é proporcionada por API's, que otimizam a experiência do usuário na página.

Visualmente falando, temos isso:

Aqui vale algumas palavras importantes: sempre que mandamos uma API para fazer algo, mandamos uma requisição/request. E ela nos retorna uma resposta/response, informando se deu certo ou não o processo que solicitamos.

Na figura acima, temos um cliente que pode usar outro sistema, um PDV por exemplo, na hora de cadastrar o cupom, aparece a listagem de produtos para ele que foi cadastrada aqui no Omie. O PDV vai puxar os produtos aqui do Omie, por meio de uma API, e mostrar para o cliente no sistema de lá para fazer a venda. E depois que a venda for realizada, ele vai nos mandar uma requisição com as informações do cupom para armazenarmos aqui no Omie, e gerar os dados financeiros e movimentação de estoque referente a venda.

📣 Resumidamente: as API’s são um conjunto de protocolos que permitem a comunicação entre dois sistemas distintos

Termos técnicos

Aqui precisamos trabalhar também com alguns termos técnicos, somente para ter uma noção do universo que estamos inseridos!

Existem diversos tipos de API’s, entre elas API Soap e API Rest e API WebSocket

As API’s Soap, usam o Simples Object Access Protocol, ou seja, o cliente e o servidor trocam mensagens por meio de XML, e era bem popular no passado, mas até hoje temos algumas aplicações do nosso dia a dia, como, por exemplo, o XML de uma nota.

Isso mesmo, a comunicação entre a Omie > Prefeitura e Omie > SEFAZ é feita por meio de uma API, que usa o XML como arquivo de comunicação.
- As API’s do Omie podem ser consumidas por meio SOAP.
As API’s Rest, são as mais populares e usadas atualmente no mundo da web. Nesse caso, o cliente envia as solicitações ao servidor como dados. O servidor por sua vez, usa essa entrada do cliente, para iniciar funções internas e retorna os dados de saída para o cliente.
- Atualmente nós não trabalhamos com esse modo hoje em dia.
E por fim, temos as API’s WebSocket que trabalha com a ideia parecida com a API Rest, porém a comunicação é feita por meio do objeto JSON.
- A nossa API também é consumida por JSON.

📣 Lembrete

Um último detalhe importante, é o que chamamos de endpoint. Toda vez que vamos usar uma API, digamos a da Omie, temos que ter um destino, certo?

Como informamos qual o servidor que estamos consumindo, ou extraindo os dados? Essa informação seria justamente o endpoint, informada em forma de URL.

Classificação das API’s

As privadas, são de uso interno da empresa sendo usadas para conectar dados e sistemas internos;
As públicas, podem ser usadas por qualquer pessoa, assim como toda as nossas API’s disponíveis no Developer;
As parceiras, podem ser usadas por desenvolvedores externos autorizados a fortalecer os processos entre as empresas;
As compostas, trabalham com duas ou mais API’s distintas, para realizar um processo complexo do sistema.