O que é uma API REST e como funciona?
Resposta curta
Uma API é um conjunto de regras e protocolos que permite a comunicação entre programas para troca de dados e funcionalidades. Uma API REST usa a web e o protocolo HTTP para expor recursos por meio de endereços e métodos padronizados.
Pontos principais
- API define como sistemas trocam dados e funções.
- API REST organiza recursos em URLs e usa métodos HTTP.
- Chave de API identifica e autentica a aplicação chamadora.
- Tokens e OAuth podem dar acesso mais específico.
- Apenas os dados necessários devem ser expostos.
Se você procura o que é uma API REST, pense em um contrato entre cliente e servidor: o cliente pede um recurso, o servidor responde com dados ou uma confirmação. Uma API, ou interface de programação de aplicações, é um conjunto de regras e protocolos que permite a comunicação entre programas para troca de dados, recursos e funcionalidades, sem compartilhar código interno.
O que é uma API REST na prática?
REST é um estilo de arquitetura para APIs que usa a web como base. Em vez de criar uma conexão personalizada para cada operação, o serviço expõe recursos, como usuários, pedidos ou produtos, em endereços da web. O cliente envia uma requisição HTTP para um desses endereços e recebe uma resposta, geralmente em JSON.
Essa abordagem separa o que o cliente precisa saber do que o servidor mantém internamente. O cliente não precisa conhecer o banco de dados, a linguagem do servidor ou a estrutura das tabelas. Ele precisa apenas do endereço do recurso, do método HTTP correto e, quando necessário, de credenciais de acesso.
Cada requisição carrega as informações necessárias para ser entendida. O servidor não depende de um histórico de conversa anterior para processar a chamada atual.
Como duas aplicações se comunicam por uma API
Uma API é o canal pelo qual dois programas se comunicam. Um programa cliente monta uma requisição com método, endereço, cabeçalhos e, às vezes, corpo. O programa servidor interpreta essa requisição, aplica regras de negócio e devolve uma resposta com status, cabeçalhos e dados.
Esse modelo permite que um aplicativo móvel, um site ou um sistema interno usem o mesmo serviço sem duplicar lógica. A API vira a fronteira entre quem consome a funcionalidade e quem a implementa.
Ao testar integrações, como limpar o cache do navegador pode evitar que uma resposta antiga seja confundida com o resultado atual da API.
O que uma chave de API faz
Para chamar uma API, usa-se uma chave de API: um identificador secreto e único que autentica e autoriza a aplicação ou o usuário. Ela serve como um código secreto apresentado ao serviço para comprovar identidade: se estiver correto, o acesso é concedido; se estiver errado, a chamada é negada.
O provedor da API gera a chave e a associa a uma conta ou projeto. Assim, ela indica quem faz a chamada e auxilia no controle de permissões, limites de uso e monitoramento.
A comparação com um cartão de biblioteca pode ajudar: a biblioteca emite um cartão numerado e confere esse número antes de liberar um empréstimo. Na API, a chave funciona como esse cartão quando um aplicativo solicita dados de outro serviço.
REST, endpoints e métodos HTTP
Em uma API REST, cada recurso tem um endereço, chamado endpoint. Um endpoint para usuários pode ser diferente de um endpoint para pedidos, e cada um aceita operações específicas.
Os métodos HTTP indicam a intenção da requisição. GET busca dados, POST cria um recurso, PUT ou PATCH altera dados e DELETE remove. A combinação entre endereço e método define a ação executada pelo servidor.
| Método | Uso típico |
|---|---|
| GET | Buscar um recurso |
| POST | Criar um recurso |
| PUT ou PATCH | Atualizar um recurso |
| DELETE | Remover um recurso |
As respostas costumam usar códigos de status HTTP. Um código de sucesso indica que a operação ocorreu como esperado; códigos de erro indicam problema de autenticação, recurso inexistente ou falha no servidor. O corpo da resposta frequentemente vem em JSON, um formato leve para troca de dados.
Exemplo de fluxo de uma requisição
Imagine um aplicativo que consulta a previsão do tempo. Ele envia uma requisição GET para o endpoint do serviço, incluindo a chave de API no cabeçalho. O servidor valida a chave, verifica a cota de uso, busca os dados e responde com um JSON contendo temperatura e condições.
Se a chave for inválida, o servidor responde com erro de autenticação. Se o endereço estiver errado, responde que o recurso não foi encontrado. Esse comportamento previsível facilita o desenvolvimento e a depuração.
Autenticação: chave, token e OAuth
Como uma API pode expor dados sensíveis, o serviço deve verificar se a aplicação que faz a chamada tem autorização. A chave de API é uma forma simples de autenticação: identifica a aplicação e atua como senha básica.
Google Cloud Platform e Amazon Web Services, entre provedores de nuvem, indicam que chaves de API autentiquem projetos, não pessoas. Quando é necessário identificar uma pessoa específica, tokens de autenticação costumam ser mais adequados, pois trazem mais informações e podem ter escopo e prazo limitados.
OAuth pode funcionar com chaves de API ou sozinho. Em alguns casos, uma empresa adota chave de API para parte dos usuários e OAuth para outra parte. JSON Web Tokens também servem para autenticação, embora sejam menos usados.
Segurança e limites de acesso
Uma boa API expõe apenas a informação necessária e oculta detalhes internos do sistema. Esse princípio reduz a superfície de ataque e facilita a manutenção.
Chaves de API devem ser tratadas como segredos. Elas não devem ser expostas em código público, repositórios ou aplicativos cliente quando puderem ser interceptadas. Se uma chave vazar, o provedor deve permitir revogá-la e gerar outra.
Além da autenticação, é comum aplicar limites de requisições por período, registro de uso e permissões por escopo. Esses controles ajudam a evitar abuso e a entender como a API é usada.
Proteger credenciais faz parte da segurança digital; veja Malwarebytes: o que é malware e como se proteger.
Como obter e usar uma chave de API
Tudo começa no site do provedor da API: em geral, o desenvolvedor cria uma conta, abre o console de gerenciamento e pede uma chave. No Google Cloud, por exemplo, o usuário acessa o console que administra serviços e APIs.
Depois de gerada, a chave é incluída nas requisições conforme a documentação do provedor. O formato exato varia: pode ser um parâmetro de consulta, um cabeçalho HTTP ou outro mecanismo definido pela API.
Por ser única, a chave permite ao provedor identificar a aplicação ou o projeto que faz a chamada. Isso permite bloquear acessos inválidos, aplicar cotas e gerar métricas de uso.
Quando uma API REST faz sentido
Uma API REST é útil quando diferentes sistemas precisam trocar dados de forma padronizada pela web. Ela serve para integrar aplicativos móveis, sites, sistemas internos e serviços de terceiros sem acoplar as implementações.
Se o objetivo é apenas compartilhar dados simples entre programas no mesmo ambiente, talvez uma biblioteca local ou um arquivo seja suficiente. Se o objetivo é expor funcionalidades para clientes externos, uma API REST com autenticação e documentação clara é mais adequada.
Muitas APIs são mantidas por projetos de software de código aberto: o que é e como usar, o que pode facilitar auditoria e personalização.
Erros comuns ao consumir uma API
Um erro frequente é tratar a chave de API como se fosse uma senha de usuário. Ela identifica a aplicação ou o projeto, não necessariamente a pessoa que usa o aplicativo. Para ações em nome de um usuário, tokens com escopo limitado são mais apropriados.
Outro erro é ignorar os códigos de status e tentar interpretar apenas o corpo da resposta. O status informa se a requisição foi bem-sucedida, se faltam credenciais ou se o recurso não existe.
Também é comum esquecer que cada requisição REST deve carregar o contexto necessário. Como o estilo é sem estado, o servidor não deve depender de uma conversa anterior para entender a chamada atual.
Se você instala e remove programas com frequência, veja como desinstalar aplicativos no Windows 11: guia prático.
Outras perguntas comuns
API e API REST são a mesma coisa?
Não. API é o conceito geral de interface entre programas; API REST é um estilo específico que usa HTTP, recursos e métodos padronizados.
Para que serve uma chave de API?
Ela identifica e autentica a aplicação ou projeto que chama a API, permitindo controle de acesso e monitoramento.
JSON é obrigatório em uma API REST?
Não. JSON é comum, mas o formato da resposta depende do serviço e da negociação entre cliente e servidor.
Posso usar chave de API para login de usuário?
Não é recomendado. Chaves identificam projetos; para usuários, tokens com escopo e validade limitados são mais adequados.
O que acontece se uma chave vazar?
O provedor pode revogá-la e gerar outra; enquanto isso, quem tiver a chave pode fazer chamadas em nome do projeto.
Páginas relacionadas
- Extensão de navegador: guia prático e seguro
Uma extensão de navegador é um pequeno módulo de software que adiciona funções ou altera o comportamento do navegador. Ela pode aumentar produtividade e personalização, mas exige atenção a permissões, fonte de instalação e manutenção.
- Armazenamento em nuvem: o que é e como funciona
Armazenamento em nuvem é o modelo em que dados ficam em servidores remotos de um provedor e são acessados pela internet ou por rede privada. Ele substitui a compra de infraestrutura local por capacidade escalável, redundância e pagamento conforme o uso. O provedor mantém a infraestrutura e protege os dados armazenados.
- Autenticação de dois fatores: guia prático
A autenticação de dois fatores exige duas provas diferentes de identidade para liberar o acesso. Ela reduz o risco de invasão mesmo quando a senha é comprometida. O método pode usar códigos, notificações, biometria ou chaves físicas.
- Oq é SaaS, exemplos e diferenças para o modelo on-premise
A diferença entre SaaS e on-premise reside no local de hospedagem, no controle dos equipamentos e no modelo financeiro. O SaaS funciona em servidores de terceiros na nuvem e é acessado via navegador sob assinatura recorrente, enquanto o on-premise exige instalação em servidores físicos locais mantidos pela própria empresa. Essa distinção define o nível de responsabilidade técnica interna, a velocidade de implantação e a governança dos dados corporativos.
- Como funciona VPN: entenda a tecnologia e os tipos
Uma rede privada virtual cria um canal de comunicação criptografado entre um dispositivo e a internet pública. Esse processo mascara o endereço IP de origem e impede que provedores ou terceiros interceptem o tráfego de dados. O recurso assegura a confidencialidade das transmissões tanto para usuários individuais quanto para redes corporativas.
- Como desinstalar aplicativos no Windows 11: guia prático
Para desinstalar aplicativos no Windows 11, use o menu Iniciar, o aplicativo Configurações ou o Painel de Controle. Apps da Microsoft Store pedem confirmação direta, enquanto programas clássicos podem abrir o próprio desinstalador. Se um app não sair, verifique permissões, reinicie o computador e procure sinais de malware.
Como esta página foi preparada
Antes da redação, o tema foi pesquisado nas fontes abaixo. Depois, a página passou por verificações automáticas de qualidade.