O que é API, sem jargão
API é a sigla de Application Programming Interface — Interface de Programação de Aplicações. A palavra que carrega o sentido é interface: um ponto de contato definido entre dois sistemas, que permite a um pedir algo ao outro sem conhecer nem acessar o funcionamento interno dele.
A comparação com o garçom explica bem a mecânica: você não entra na cozinha, não conhece as receitas e não precisa saber quem cozinha. Faz o pedido pelo cardápio, e a comida chega. O cardápio é a documentação; o garçom é a API; a cozinha é o sistema que você jamais vê.
Traduzindo para o dia a dia: quando um site de loja mostra o valor do frete, ele não tem uma tabela dos Correios guardada. Ele pergunta em tempo real, por API, e mostra a resposta. Quando o CEP preenche o endereço sozinho, é a mesma coisa.
Como funciona uma chamada de API
Toda integração segue o mesmo ciclo, e entendê-lo já resolve metade das conversas técnicas:
- Requisição: seu sistema envia um pedido a um endereço específico, com os dados necessários
- Autenticação: a API confere se você tem permissão, normalmente por chave ou token
- Processamento: o sistema do provedor executa a consulta ou a ação solicitada
- Resposta: devolve o resultado, quase sempre em JSON, acompanhado de um código de status
- Uso: seu sistema interpreta e exibe ou grava a informação
Tudo isso costuma acontecer em frações de segundo, dezenas de vezes por página. Um checkout comum dispara chamadas de CEP, frete, antifraude e pagamento antes de o cliente ver "pedido confirmado".
Anatomia de uma requisição
Quatro elementos aparecem em praticamente qualquer documentação:
| Elemento | O que é | Exemplo |
|---|---|---|
| Endpoint | O endereço do recurso | /api/v1/pedidos |
| Método | A ação pretendida | GET (ler), POST (criar), PUT (atualizar), DELETE (excluir) |
| Parâmetros / corpo | Os dados enviados | número do CEP, valor da compra, texto da mensagem |
| Cabeçalhos | Metadados e credenciais | chave de autenticação, formato aceito |
Os métodos HTTP estão documentados no MDN e valem para praticamente toda API web moderna — vale a leitura de quem vai acompanhar um projeto de integração de perto.
Códigos de status: o que a API está dizendo
Toda resposta traz um número que resume o que aconteceu. Conhecer os principais economiza muito tempo em reuniões técnicas:
- 200 / 201: deu certo — a informação veio ou o registro foi criado
- 400: requisição malformada, geralmente dado faltando ou em formato errado
- 401 / 403: problema de credencial ou de permissão
- 404: o recurso solicitado não existe naquele endereço
- 429: requisições demais no período — o limite do plano foi atingido
- 500 e outros 5xx: a falha está no servidor do provedor, não no seu
A lista completa de códigos HTTP é a referência para quem precisa diagnosticar integrações que pararam de funcionar.
Tipos de API: REST, SOAP e GraphQL
Você vai ouvir esses três nomes em qualquer conversa de integração:
| Padrão | Como organiza | Onde aparece |
|---|---|---|
| REST | Endereços fixos por recurso, resposta em JSON | Padrão dominante na web — a maioria das APIs modernas |
| SOAP | Protocolo rígido baseado em XML, com contrato formal | Bancos, sistemas legados, integrações governamentais |
| GraphQL | Endereço único, o cliente define os campos que quer | Aplicativos com muitas telas e necessidades diferentes de dados |
Para a maior parte dos projetos de site e e-commerce, REST resolve. GraphQL compensa quando o desperdício de dados é grande; SOAP raramente é escolha, mas costuma ser imposição de quem está do outro lado.
Webhooks: quando a API avisa você
Existe uma diferença prática que confunde muita gente. Na API tradicional, seu sistema pergunta: "esse pagamento foi aprovado?". No webhook, o outro sistema avisa assim que o evento acontece.
A distinção importa porque muda o custo e a experiência. Perguntar de minuto em minuto desperdiça requisições e atrasa a resposta ao cliente; receber a notificação no instante exato permite disparar o e-mail de confirmação imediatamente.
Webhooks são o que sustentam boa parte da automação de marketing: pagamento aprovado dispara sequência de boas-vindas, formulário enviado cria contato no CRM, entrega concluída pede avaliação.
APIs públicas, de parceiros e privadas
- Públicas (abertas): qualquer um usa, às vezes sem cadastro — consulta de CEP, cotação de moedas, dados abertos governamentais
- De parceiros: exigem contrato ou aprovação — gateways de pagamento, marketplaces, API oficial do WhatsApp Business
- Privadas (internas): criadas pela própria empresa para conectar seus sistemas, sem exposição externa
Empresas em crescimento acabam construindo APIs privadas por um motivo simples: quando o site, o ERP, o aplicativo e o painel administrativo precisam da mesma informação, uma API central evita quatro versões divergentes do mesmo dado.
Integrações que fazem diferença no negócio
Saindo da teoria, é aqui que a API vira resultado:
- Pagamentos: Pix, cartão e boleto processados sem sair do seu site — essencial em qualquer loja virtual
- Frete: prazo e valor reais por CEP e peso, calculados no checkout
- CEP e endereço: menos campos para o cliente preencher, menos abandono
- WhatsApp: confirmações e notificações automáticas pela API oficial
- CRM: lead do formulário cai direto na fila do comercial, com origem registrada
- ERP e estoque: preço e disponibilidade sincronizados, sem venda de produto esgotado
- Emissão fiscal: nota emitida automaticamente após a confirmação do pedido
Cada uma dessas integrações remove trabalho manual e uma fonte de erro humano. É por isso que integração bem-feita costuma pagar o próprio custo em poucos meses.
Segurança: onde as integrações costumam falhar
API não é insegura por natureza — implementação descuidada é. Os cuidados que separam projeto profissional de improviso:
- Chaves no servidor, nunca no navegador: credencial escrita no JavaScript da página está pública para qualquer visitante
- HTTPS sempre: sem certificado SSL, os dados trafegam abertos
- Permissão mínima: se a integração só precisa ler, não conceda chave que também escreve
- Rotação de credenciais: troque chaves periodicamente e imediatamente após qualquer desligamento de fornecedor
- Validação da entrada: nunca confie cegamente no dado que chega de fora
- Tratamento de indisponibilidade: quando o provedor cair, seu site precisa degradar com elegância, não quebrar
Essa última linha é a mais esquecida — e a que mais custa. Site que exibe tela de erro porque uma API de terceiros ficou fora do ar perde a venda inteira por um problema que não é seu. Vale conferir também o que torna um site blindado.
Quanto custa integrar uma API
O custo tem duas camadas que precisam ser somadas desde o orçamento:
- Custo do provedor: gratuito, por volume de requisições, por transação (comum em pagamentos) ou mensalidade fixa
- Custo de desenvolvimento: leitura da documentação, implementação, tratamento de erros, testes e manutenção
A conta que muita empresa esquece é a manutenção: APIs mudam de versão, credenciais expiram e provedores descontinuam recursos. Integração é ativo vivo, e precisa de responsável definido.
Como avaliar uma API antes de adotar
- Documentação: clara, com exemplos e ambiente de testes? API mal documentada dobra as horas de projeto
- Estabilidade e histórico: há status público de disponibilidade? Com que frequência cai?
- Política de versões: quanto tempo de aviso antes de descontinuar algo?
- Limites de uso: o plano suporta seu pico de vendas, não sua média?
- Suporte: existe canal técnico real ou apenas fórum comunitário?
- Saída: se precisar trocar de provedor, quanto do trabalho se perde?
Erros comuns em integrações
- Não tratar falha do provedor — o site inteiro quebra por causa de um serviço externo
- Expor credenciais no código do lado do cliente ou em repositório público
- Ignorar os limites de requisição e descobrir o erro 429 na Black Friday
- Confiar sem validar os dados recebidos de fora
- Integrar tudo de uma vez em vez de começar pelo que gera mais retorno
- Esquecer os testes em ambiente de homologação antes de subir para produção
- Não monitorar — descobrir que a integração parou pela reclamação do cliente
"API boa é a que ninguém percebe: o cliente digita o CEP, o endereço aparece, o frete calcula e o pagamento aprova — e nada disso foi construído por você."
Perguntas frequentes sobre API
O que é API em palavras simples?
API é o conjunto de regras que permite a dois sistemas conversarem entre si. Seu site pede uma informação ou ação de outro serviço — consultar um CEP, cobrar um cartão, enviar uma mensagem — e recebe a resposta pronta, sem acessar o sistema alheio por dentro.
O que significa a sigla API?
API significa Application Programming Interface, ou Interface de Programação de Aplicações. "Interface" é a palavra-chave: ela define o ponto de contato público entre sistemas, escondendo toda a complexidade interna de quem oferece o serviço.
Para que serve uma API no site da minha empresa?
Serve para o site fazer o que sozinho não faria: calcular frete com a transportadora, processar pagamento, preencher endereço pelo CEP, enviar leads direto ao CRM, disparar mensagens no WhatsApp ou sincronizar estoque com o ERP.
Qual a diferença entre API REST e GraphQL?
REST organiza a informação em endereços fixos, e cada um devolve um pacote pronto de dados. GraphQL expõe um único endereço onde o cliente descreve exatamente os campos que quer, reduzindo dados desnecessários. REST é mais comum; GraphQL brilha em aplicações com muitas telas diferentes.
O que é um webhook e como difere de uma API comum?
Numa API comum, seu sistema pergunta e o outro responde. No webhook, o outro sistema avisa você assim que algo acontece — pagamento aprovado, pedido enviado. É a diferença entre ligar de hora em hora perguntando e receber a notificação no momento exato.
Usar API é seguro?
É seguro quando bem implementada: conexão HTTPS, chaves e tokens guardados no servidor (nunca no código visível do site), permissões mínimas necessárias e limite de requisições. O risco quase sempre vem da implementação descuidada, não da tecnologia.
API custa dinheiro?
Depende do provedor. Muitas são gratuitas (consulta de CEP, cotação de moedas), outras cobram por volume de requisições ou por transação, como gateways de pagamento e APIs de mensageria. Some sempre o custo do provedor ao custo do desenvolvimento da integração.
Preciso de programador para integrar uma API?
Integrações simples já vêm prontas em plugins de plataformas populares. Fora desses casos, sim: alguém precisa ler a documentação, tratar erros, cuidar da segurança e testar. Integração malfeita costuma falhar exatamente quando o cliente está tentando comprar.
O que significa o erro 401 ou 429 de uma API?
São códigos de status HTTP. O 401 indica falta de autenticação válida — chave errada, expirada ou ausente. O 429 significa excesso de requisições no período permitido. Já o 200 confirma sucesso e os códigos 5xx apontam falha no servidor do provedor.
O que é documentação de API e por que ela importa?
É o manual que descreve endereços disponíveis, parâmetros aceitos, formato das respostas e limites de uso. Antes de escolher um provedor, avalie a documentação: API mal documentada custa muito mais horas de desenvolvimento e quebra sem aviso.