API significa Application Programming Interface ou, em português, Interface de Programação de Aplicações.
De forma simples, API é uma ponte que permite que dois sistemas diferentes conversem entre si de maneira padronizada, segura e automática.
Pense na API como um garçom em um restaurante:
Você faz um pedido (solicitação).
O garçom (API) leva seu pedido até a cozinha (outro sistema).
A cozinha prepara o prato e entrega ao garçom, que traz a resposta para você.
Essa comunicação é feita seguindo regras específicas que garantem que ambos os lados se entendam.
Termo |
Explicação simples |
|
API
|
Ponte que conecta sistemas diferentes.
|
|
Como funciona?
|
Um sistema pede algo → API leva o pedido → Outro sistema responde → API entrega a resposta.
|
|
Integração de API
|
Dois ou mais sistemas trabalhando juntos através da API.
|
|
Qual a importância?
|
Automatiza, conecta, acelera e escala operações.
|
Apresentação
Além deste material, nossa equipe de tecnologia também preparou uma apresentação mais técnica sobre o funcionamento das APIs.
Como as APIs funcionam?
As APIs funcionam como intermediárias entre duas aplicações:
Um sistema faz uma solicitação para a API (por exemplo, buscar dados, enviar informações, etc.).
A API processa essa solicitação e se comunica com o sistema que tem as informações necessárias.
O sistema responde à API.
A API traz a resposta de volta para o sistema que fez o pedido.
Solicitação de API
Para solicitar o acesso à API, entre em contato diretamente com o seu gerente de contas. Ele é o responsável por conduzir todo o processo de liberação e orientá-lo nos próximos passos.
Por que as APIs são importantes?
Automatizam processos: eliminam a necessidade de digitação manual ou importação/exportação manual de dados.
Conectam sistemas diferentes: mesmo sistemas feitos em linguagens ou empresas diferentes podem "falar a mesma língua" via API.
Aceleram integrações: permitem adicionar novas funcionalidades rapidamente, sem precisar criar tudo do zero.
Escalam negócios: novas parcerias, plataformas ou recursos podem ser ativados via API, aumentando o alcance do serviço.
O que é um webhook?
Se a API é o garçom que leva o seu pedido até a cozinha e traz a comida para você quando você pede, o webhook é um pouco diferente.
O webhook é a cozinha avisando você automaticamente quando a comida ficou pronta, sem você precisar pedir.
API tradicional:
Você precisa chamar o garçom toda hora para perguntar:
"Já ficou pronto?"
"Já ficou pronto?"
"Já ficou pronto?"
Webhook:
A cozinha avisa o garçom assim que o prato fica pronto, e o garçom já traz para você, sem você precisar perguntar.
O que são integrações de API?
Integração de API é quando duas ou mais empresas, sistemas ou aplicativos se conectam usando APIs para trocar informações de maneira automática.
Exemplos do dia a dia:
Um site de e-commerce conecta sua loja a um sistema de pagamento (como Paytime) através de API.
Um aplicativo de delivery usa APIs de mapas para mostrar a localização dos motoboys em tempo real.
Um sistema de CRM puxa informações automáticas de redes sociais através de APIs.
Resumo:
Integrar APIs é "ligar" dois sistemas para que eles trabalhem juntos de forma inteligente e fluida.
Na prática
Para facilitar o entendimento, vamos usar um exemplo prático de utilização de APIs: o caso do iFood. Embora o iFood não seja cliente da Paytime, ele é um exemplo ideal por ser um sistema amplamente conhecido por todos.
O iFood é um aplicativo focado em serviços de delivery. Porém, para que esse serviço funcione de forma completa, o iFood integra soluções de captura de pagamentos e serviços bancários fornecidos por uma fintech, a Zoop.
A integração via API e os serviços financeiros oferecidos pela Zoop foram tão fundamentais para o funcionamento e crescimento do iFood que, em 2024, o iFood decidiu adquirir a Zoop, consolidando essas soluções dentro do seu próprio ecossistema.
A seguir, vamos detalhar passo a passo como o iFood utiliza APIs para oferecer sua solução.
Cadastro do restaurante
O primeiro passo para realizar uma venda é o restaurante se cadastrar no iFood. Durante esse processo, sem perceber, o restaurante também é automaticamente cadastrado na Zoop, a fintech responsável pelos serviços de pagamento.
Ao finalizar o cadastro no aplicativo, o iFood coleta automaticamente as informações fornecidas pelo restaurante e as envia para a Zoop por meio de uma integração via API.
Em seguida, os dados passam por um processo de análise. Quando o cadastro é aprovado ou recusado, a Zoop envia um webhook para o iFood, comunicando o status atualizado. O iFood, então, atualiza essa informação no aplicativo, refletindo o novo status para o restaurante de forma automática.
Com o cadastro aprovado, o restaurante passa a estar habilitado para vender seus produtos na plataforma do iFood.
Pedido
Quando você acessa o cardápio no iFood, realiza um pedido e faz o pagamento online, perceberá que a cobrança na fatura do seu cartão aparece em nome do restaurante.
Isso acontece porque o iFood utiliza as APIs da Zoop para capturar a venda diretamente para o restaurante, garantindo que o valor já seja processado em nome dele.
Split
Um dos grandes diferenciais da solução do iFood é a funcionalidade de split de pagamentos. O iFood retém uma comissão sobre cada venda, que pode variar entre 17% e 27,5%, dependendo da negociação com o restaurante, da forma de pagamento e da logística de entrega.
Para receber essa comissão, o iFood utiliza a API de split, que realiza automaticamente a divisão do valor no momento da captura da venda, descontando o percentual correspondente e repassando-o diretamente ao iFood.
Essa estrutura é fundamental para evitar a bitributação, garantindo que o valor de cada transação seja tributado corretamente, sem incidência duplicada, uma única tributação para o restaurante e o repasse correto para o iFood.
Recebimento dos valores
Cada restaurante possui uma conta no sistema bancário da Zoop, onde são depositados os valores das vendas realizadas.
No entanto, o restaurante não precisa acessar a plataforma da Zoop diretamente. O iFood utiliza as APIs de Banking da Zoop para integrar toda a gestão financeira dentro do próprio aplicativo, permitindo que o restaurante acompanhe seus recebimentos de forma prática e centralizada, como mostrado no print abaixo.
Gestão dos valores
Com os valores disponíveis na conta, o restaurante pode, diretamente pelo portal do iFood, realizar transferências via PIX ou TED, efetuar o pagamento de boletos, quitar fornecedores e outras operações financeiras.
Todas essas transações são feitas dentro do ambiente do iFood, mas quem executa tudo nos bastidores são as APIs da Zoop.
De forma simples: o portal do iFood é a "tela" que o restaurante vê (front-end); a API (back-end) é o "motor" invisível que faz tudo acontecer por trás dessa tela.
A API é uma ponte que conecta sistemas externos (como ERPs, plataformas de e-commerce ou aplicativos) aos serviços da Paytime. Com ela, você consegue realizar operações como:
Gerar boletos e cobranças por cartão ou Pix;
Consultar transações e saldos;
Automatizar splits de pagamento;
Cadastrar estabelecimentos;
Tudo isso de forma automática e segura.
Para mais detalhes técnicos sobre a API, incluindo exemplos de requisições, respostas e parâmetros disponíveis, acesse a documentação completa em CLIQUE AQUI.