API, explicada sem código

A tela de entrega de uma loja virtual com o CEP preenchido, ao lado do sistema da transportadora, que recebe o CEP e o peso e devolve o preço e o prazoSoftware

Quando você digita o CEP numa loja e o frete aparece, quem calculou o preço não foi a loja. Ela mandou o CEP e o peso do pacote para o sistema da transportadora, que respondeu com o preço e o prazo. Essa conversa entre os dois sistemas acontece por uma API.

API é a sigla em inglês para interface de programação de aplicações. Na prática, é o jeito combinado de um sistema pedir algo a outro: um faz o pedido num formato que os dois conhecem, e o outro responde no mesmo formato. Quem pede não precisa saber como o outro lado funciona por dentro, só como fazer o pedido.

Onde você já usou uma hoje

Quase todo produto digital conversa com outros sistemas o tempo todo:

  • O frete na loja, calculado pela transportadora.
  • O pagamento no app, aprovado pelo banco ou pela empresa do cartão.
  • O login com a conta do Google, em que o Google confirma quem você é sem entregar a sua senha ao app.
  • O mapa dentro do aplicativo de entrega, que vem de um serviço de mapas.
  • A nota fiscal emitida sozinha, enviada ao sistema da prefeitura ou da Receita.

Em todos eles, a mesma informação não precisa ser digitada duas vezes. É esse o ganho de uma integração: um sistema faz o trabalho do outro sem ninguém no meio copiando e colando.

Pedido e resposta

Toda API funciona no mesmo ritmo. Um sistema pede, o outro responde.

O pedido diz o que se quer e traz o que for preciso para responder: o CEP, o peso, o valor da compra. A resposta traz o resultado ou um aviso de que algo deu errado, como um CEP que não existe. Quem combina o formato dos dois é quem oferece a API, e ele publica essas regras num documento, a documentação.

A loja pede o frete com o CEP e o peso, e a transportadora responde com o preço e o prazo

Algumas APIs também avisam por conta própria. Em vez de o seu sistema perguntar de cinco em cinco minutos se o pagamento caiu, o banco chama o seu sistema quando cai. Esse aviso tem um nome técnico, webhook, mas a ideia é a de uma ligação de volta.

No sistema da própria Pump é assim que o contrato chega à assinatura: ele vai para o serviço de assinatura eletrônica por API, e, quando todos assinam, o serviço avisa o nosso sistema, que segue para a próxima etapa sem ninguém precisar conferir.

Ter API não é ter integração

Ter uma API disponível não quer dizer que a integração está pronta. A API é o que o outro sistema oferece. A integração é o que o seu produto faz com ela: quando pedir, o que fazer com a resposta e o que mostrar quando ela não vem.

Ligar dois sistemas no caso em que tudo dá certo é rápido. O que leva tempo é decidir o que acontece em todos os outros casos.

O que perguntar antes de integrar

  1. Que dados vão e voltam? Só o necessário. Se a integração envia dados pessoais, vale saber quem do outro lado pode vê-los e por quanto tempo ficam guardados, como pede a LGPD, a lei de proteção de dados.
  2. E se o outro lado cair? Todo sistema fica fora do ar de vez em quando. A pergunta é o que a pessoa vê na tela nessa hora, quantas vezes o seu sistema tenta de novo e como evita fazer a mesma cobrança duas vezes.
  3. Tem limite ou custo? Muitas APIs cobram por pedido ou limitam quantos cabem por minuto. Uma integração que funciona bem com dez clientes pode ficar cara com mil.
  4. Quem guarda a chave? Para usar uma API, o seu sistema recebe uma chave de acesso, que funciona como uma senha. Ela precisa ficar guardada no servidor, nunca dentro do app ou do site, onde qualquer um pode encontrá-la.
  5. Quem cuida quando mudar? A empresa que oferece a API atualiza o que ela faz e, de tempos em tempos, desliga versões antigas com aviso prévio. Alguém precisa acompanhar esses avisos, ou a integração para de funcionar num dia qualquer.

Integrar ou construir?

Se a ferramenta que a sua empresa usa já faz o que você precisa, integrar costuma ser o caminho mais barato: o produto conversa com ela em vez de refazer o que ela já faz. Pagamento, emissão de nota, assinatura de contrato e envio de e-mail quase sempre entram assim.

Construir faz sentido quando a regra é do seu negócio e nenhuma ferramenta pronta a segue. Nesse caso, o que se constrói é um sistema sob medida, e ele provavelmente também vai ter APIs, para conversar com o resto.

Na Pump

As integrações de um projeto aparecem cedo, no Discovery, junto com as regras de negócio: o que precisa conversar com o quê, que dados passam e o que acontece quando um dos lados não responde. Quem fica com as contas e as chaves de cada serviço também é combinado ali, porque elas devem estar no nome da empresa do cliente, e não no nosso.

#Software#API#integrações#sistemas
Davi
Davi
Fundador da Pump e redator desde 2021. Apaixonado por tecnologia e cultura pop.
← Voltar ao blog