GLOSSÁRIO

O que é uma API?

  Esta página foi traduzida automaticamente por DeepL. Switch to English

Uma API (Interface de Programação de Aplicações) é um conjunto de regras que permite que um software comunique com outro. Pense nisso como um menu: a sua aplicação pode «encomendar» dados ou ações, e a API diz à cozinha (um serviço) exatamente o que cozinhar e como será servido.

As APIs padronizam a forma como as solicitações são feitas e as respostas são devolvidas, para que diferentes sistemas possam funcionar juntos de forma confiável, mesmo que tenham sido criados por equipas, empresas ou em linguagens de programação diferentes.

how-a-web-api-works

O que uma API realmente faz?

Em termos práticos, uma API define pontos finais (endereços que pode chamar), os métodos que pode usar (como GET para obter dados ou POST para enviar dados), o formato do que envia (geralmente JSON) e o que deve esperar em troca (dados mais um código de estado como 200 para «OK» ou 404 para «Não encontrado»). Essa previsibilidade é o ponto principal.

API vs. SDK vs. UI: qual é a diferença?

  • API: O contrato sobre o que pode solicitar e como obterá uma resposta.
  • SDK (Software Development Kit): Um kit de ferramentas que geralmente inclui uma API com código pronto, exemplos e utilitários para facilitar o uso da API.
  • UI (Interface do Utilizador): O que os humanos clicam e tocam. As APIs são para software-para-software; as UIs são para pessoas.

Se quiser ser exato, pode usar uma API sem um SDK, mas usar um SDK pode economizar tempo e reduzir erros.

Existem diferentes «tipos» de APIs?

Sim, vários estilos, cada um com vantagens e desvantagens:

  • REST: O estilo web mais comum atualmente. Baseado em recursos, utiliza métodos HTTP (GET/POST/PUT/DELETE), normalmente JSON.
  • GraphQL: os clientes especificam os campos exatos de que precisam em uma única solicitação — ótimo para reduzir o excesso ou a falta de recuperação de dados.
  • SOAP: Protocolo mais antigo baseado em XML com contratos rigorosos ainda utilizado em algumas empresas.
  • gRPC: Protocolo binário de alto desempenho popular para microsserviços.
  • Webhooks: Não é uma solicitação que você faz, mas uma resposta que o provedor envia para você quando algo acontece (como uma notificação de entrega).
rest-api

Vale a pena usar uma API?

Normalmente, sim. Em vez de construir tudo sozinho, as APIs permitem-lhe integrar pagamentos, mapas, e-mail, pesquisa, análises, IA e muito mais. Isso poupa tempo de engenharia, melhora a fiabilidade (o fornecedor mantém o seu serviço atualizado) e permite que a sua equipa se concentre no que torna o seu produto único.

As desvantagens: você herda limites de taxa, preços e dependências de tempo de atividade do seu provedor. Se o seu produto não puder funcionar sem essa API, planeje uma redundância.

Preciso de uma «chave» especial para usar uma API?

Frequentemente. Muitas APIs exigem autenticação para que o fornecedor saiba quem você é e possa aplicar permissões e limites de taxa. As abordagens comuns incluem:

  • Chaves API: tokens simples que você envia com cada solicitação.
  • OAuth: Um método delegado mais seguro, excelente quando precisa de acesso em nome de um utilizador.
  • Solicitações assinadas/JWTs: tokens assinados criptograficamente que expiram e podem conter reivindicações (quem é, o que tem permissão para fazer).

Mantenha as chaves e os tokens fora dos repositórios públicos e do código do lado do cliente sempre que possível.

Preciso de ferramentas especiais para chamar uma API?

Na verdade, não. Um navegador da Web, curl ou qualquer cliente HTTP funciona para muitas APIs. Os programadores costumam usar ferramentas como Postman ou bibliotecas de linguagem integradas para fazer solicitações, inspecionar respostas e salvar exemplos. Para aplicações de produção, você usará a biblioteca HTTP da sua linguagem ou o SDK do fornecedor.

O que utiliza APIs no mundo real?

Praticamente tudo que é moderno: aplicações móveis que extraem perfis, «Iniciar sessão com Google/Apple», lojas online que processam pagamentos, dispositivos domésticos inteligentes que sincronizam, painéis que extraem análises, até mesmo o seu widget meteorológico. Se o software está a trocar dados, é provável que haja uma API por trás disso.

client-server-architecture

Jargão que irá encontrar (e o que significa)

  • Ponto final: a URL que você chama (por exemplo, /users/123).
  • Pedido/Resposta: O que você envia versus o que você recebe de volta.
  • Carga útil/corpo: os dados contidos numa solicitação ou resposta.
  • Código de estado: Resultado numérico (200 OK, 201 Criado, 401 Não autorizado, 429 Demasiadas solicitações, 500 Erro do servidor).
  • Limite de taxa: quantas chamadas pode fazer num determinado período de tempo.
  • Versões: Manter separados os comportamentos antigos e novos da API (por exemplo, /v1/ vs. /v2/).
  • Idempotente: Fazer a mesma solicitação várias vezes produz o mesmo resultado (por exemplo, GET).

CONTEÚDO RELACIONADO