O que é API pública? Entenda como funciona

Uma API pública (interface de programação de aplicações) é um mecanismo que permite a qualquer pessoa na internet integrar ferramentas externas ao seu site ou aplicativo. Ela funciona disponibilizando endpoints que os usuários podem utilizar para solicitar serviços ou dados específicos do servidor.

Os desenvolvedores utilizam APIs públicas por sua eficiência, simplicidade e grandes conjuntos de dados, o que lhes permite aprimorar seus aplicativos sem precisar desenvolver tudo do zero. As APIs públicas são gratuitas e estão disponíveis para uso por qualquer pessoa, ao contrário das APIs privadas ou internas

Você pode usar uma API pública em cinco passos simples:

1. Encontre uma API pública em um site ou plataforma como o GitHub.
2. Leia a documentação da API para saber mais sobre suas especificações, funcionalidades e requisitos.
3. Crie uma conta no site do provedor da API para receber o endpoint e a chave de autenticação.
4. Teste a funcionalidade da API enviando uma solicitação ao servidor usando uma ferramenta como o cURL ou o Postman.
5. Integre a API pública ao seu aplicativo inserindo as funções no back-end.

Vamos aprender mais sobre API pública, onde encontrá-la e como integrá-la ao seu aplicativo

Como funciona uma API pública?

Para entender como uma API pública funciona, vamos usar um restaurante como analogia

Pense em um restaurante onde qualquer pessoa pode entrar e pedir a comida que quiser. Isso é semelhante a uma API pública, que os desenvolvedores podem usar para acessar diferentes dados ou serviços

Usar uma API pública é como fazer um pedido em um restaurante; há um processo específico a ser seguido, com diferentes partes trabalhando juntas para atender à sua solicitação. Vamos analisar cada uma delas.

Endpoints

Em um restaurante, você pede um prato específico selecionando um item do cardápio. É uma forma de informar aos cozinheiros na cozinha o que você deseja comer

Nas APIs, os itens do menu são semelhantes aos endpoints – URLs que especificam quais serviços, ferramentas ou dados você deseja acessar. Eles são especificados no final da URL base da API, desta forma:

provedor-api.com.br/serviço

Métodos HTTP

Seu aplicativo usa métodos HTTP para especificar a solicitação de interação com uma API. Isso é semelhante a falar com o garçom em um restaurante ao fazer um pedido

Aqui estão os métodos HTTP, suas funções e analogias equivalentes:

Resposta da API

Respostas da API são as informações que o servidor retorna ao receber suas solicitações, escritas no formato JSON. Elas podem conter uma lista de dados ou o status da solicitação

Em um restaurante, isso é semelhante a um recibo que você recebe após fazer, alterar, verificar ou cancelar seu pedido. Pode ter a seguinte aparência:

{
"order_id": 123,

  "item": "Lanche",

  "status": "Em preparo"

}

Limitação de taxa

A limitação de taxa é um sistema que define o número máximo de solicitações que uma API pode processar. É fundamental para evitar que a API fique sobrecarregada, o que pode causar problemas como falta de resposta ou tempo de inatividade

Esse recurso de limitação de taxa é semelhante a uma política de restaurante que permite apenas um número específico de pedidos dentro de um determinado período

Chaves de API

As chaves de API são tokens de autorização que o provedor utiliza para verificar a validade e a legitimidade das solicitações. Esse sistema melhora a segurança e é crucial para tarefas como a limitação de taxa, pois permite que o provedor da API rastreie cada solicitante.

As chaves de API são semelhantes a um comprovante de reserva de restaurante, que verifica quem você é e quando você tem permissão para entrar.

Por que os desenvolvedores utilizam APIs públicas?

Os desenvolvedores costumam usar APIs públicas por vários motivos, tais como:

• Eficiência: os desenvolvedores podem adicionar recursos como mapas ou um gateway de pagamento às suas aplicações sem precisar desenvolvê-los do zero, economizando tempo e esforço.
• Integração de ecossistemas: as APIs públicas permitem que os desenvolvedores integrem plataformas às suas aplicações. Por exemplo, elas podem permitir inscrições usando uma conta do Google.
• Agilidade na criação de protótipos: o desenvolvimento inicial de um sistema demanda a implementação rápida de novas funcionalidades, e o uso de APIs viabiliza essa entrega de forma praticamente imediata.
• Escalabilidade: como os desenvolvedores de API gerenciam os serviços, você não precisa mantê-los e pode se concentrar em seu aplicativo.
• Acesso a dados: os desenvolvedores de aplicativos podem usar APIs públicas para integrar dados prontamente disponíveis e em tempo real com o mínimo de esforço.

Casos de uso de APIs públicas

As APIs públicas impulsionam muitos dos recursos que usamos todos os dias. Desde a incorporação de mapas até o processamento de pagamentos, aqui estão algumas das formas mais comuns como os desenvolvedores as colocam em prática:

• Pesquisa e descoberta: permita que os usuários pesquisem e acessem conteúdo específico de plataformas externas. Por exemplo, a API do YouTube permite que aplicativos pesquisem vídeos, recuperem detalhes e os incorporem diretamente.
• Clima: forneça aos usuários atualizações e previsões meteorológicas em tempo real. Por exemplo, a API do OpenWeatherMap permite que você exiba condições atuais, previsões para vários dias e alertas meteorológicos.
• Mapas: incorpore mapas interativos e habilite serviços baseados em localização em seu aplicativo. Por exemplo, a API do Google Maps oferece suporte à pesquisa de endereços, rotas e locais próximos.
• Pagamentos e comércio eletrônico: facilite pagamentos online seguros e gerencie transações da loja. Por exemplo, a API do Stripe permite o processamento de cartões de crédito, o faturamento de assinaturas e o gerenciamento de pedidos.
• Redes sociais e mensagens: integre interações sociais e recursos de comunicação. Por exemplo, a API X permite publicar conteúdo, ter dados de usuários e acompanhar métricas de engajamento.
• Gerenciamento de serviços: otimize a autenticação de usuários, o agendamento ou o suporte ao cliente. Por exemplo, a API da Hostinger ajuda a otimizar compras, gerenciamento de produtos e recuperação de informações.

Comparando tipos de API

Além das públicas, existem outros tipos de API para diferentes casos de uso. Aqui está a comparação entre elas.

API pública vs API privada

Uma API privada é semelhante à pública no sentido de que partes externas ao provedor podem utilizá-la. No entanto, a API privada é restrita apenas a usuários qualificados, como assinantes ou parceiros

Em contrapartida, uma API pública permite que qualquer pessoa a utilize gratuitamente, desde que possua o endpoint e uma chave de autenticação válida

API pública vs API interna

Uma API interna está disponível apenas para os desenvolvedores ou organizações que a criaram. Ela é projetada especificamente para suas necessidades e é usada para integrar diferentes serviços, ferramentas e recursos dentro de um projeto

Por exemplo, um aplicativo com arquitetura de microsserviços costuma usar uma API interna para distinguir as solicitações dos usuários e encaminhá-las a serviços específicos, como autenticação ou operações de banco de dados.

Como começar a usar uma API pública?

As etapas para usar e integrar uma API pública podem variar ligeiramente dependendo do provedor. No entanto, o procedimento geral é semelhante.

1. Encontre uma API pública

Vamos começar encontrando uma API pública que atenda às suas necessidades e preferências. Existem vários repositórios onde você pode explorar diferentes APIs públicas, incluindo a lista de APIs públicas no GitHub

Para escolher a API pública certa, considere os seguintes fatores:

• Reputação: uma API de boa reputação, proveniente de uma empresa renomada ou com avaliações positivas dos usuários, é confiável e segura, garantindo tranquilidade.
• Recursos: como as APIs públicas oferecem diferentes recursos e funcionalidades, escolha uma que atenda às necessidades de sua aplicação.
• Qualidade da documentação: uma documentação abrangente ajuda a compreender como a API funciona e simplifica a integração e a resolução de problemas.
• Limites de taxa: se o seu aplicativo requer chamadas frequentes à API, escolha uma API pública com um limite de taxa mais alto para garantir que ela permaneça responsiva durante picos de tráfego.
• Comunidade e suporte: uma comunidade e um suporte robustos agilizam o processo de integração da API, pois você pode facilmente pedir ajuda se necessário.
• Autenticação e segurança: a API ideal deve fornecer um método de autenticação seguro que atenda aos requisitos do seu aplicativo, como OAuth ou uma chave de API.
• Licenciamento e política: se você usar os serviços ou dados da API para fins comerciais, certifique-se de que a licença permita tal uso.

2. Leia a documentação da API

Ler a documentação da API é fundamental para compreender como ela funciona e como integrá-la corretamente à sua aplicação.

Isso porque a documentação contém informações essenciais sobre a API pública, tais como:

• URL base: o endereço principal do provedor da API que você utilizará para acessar os endpoints, como api.hostinger.com/v1/.
• Endpoint: o endereço a partir do qual seu aplicativo pode acessar serviços ou dados específicos. Ele está localizado no final da URL base, como api.hostinger.com/v1/endpoint/.
• Autenticação: o método que a API utiliza para autenticar sua aplicação. Você deve usar o método correto para se conectar ao endpoint.
• Métodos suportados: o método HTTP que sua aplicação pode usar para solicitar dados ou serviços da API.
• Formatação: a estrutura da resposta da API. Ela varia de acordo com a API, e você deve compreendê-la para exibir os dados corretamente em seu site.
• Parâmetros: variáveis obrigatórias e opcionais especificadas na solicitação da API para consultar dados específicos.
• Código de status: mensagens que indicam o status da sua chamada de API, seja ela bem-sucedida ou não. Isso é crucial para o diagnóstico de problemas e a criação de um mecanismo de tratamento.

3. Cadastre-se e gere uma chave de API

Para receber o endpoint e a chave de API, devemos criar uma conta na plataforma do provedor de API. O processo deve ser semelhante independentemente do provedor, mas as etapas específicas podem variar ligeiramente.

Para fins de demonstração, veja a seguir como criar uma conta no Hostinger e ter uma chave de API a partir dela

1. Abra a página de criação de conta da Hostinger.
2. Insira seu endereço de e-mail e senha. Clique em Registrar.
3. Acesse o hPanel usando sua nova conta Hostinger.
4. Clique no ícone de perfil e selecione “Informações da conta”.

5. Vá para a barra lateral → API.
6. Clique no botão Novo token. Isso abrirá a janela de criação da chave API.
7. Insira um nome para o seu token e defina uma data de validade. Clique em “Gerar”.

Depois de ter a chave da API, guarde-a em um local seguro, pois a utilizaremos posteriormente. Observe que os provedores de API geralmente impedem que você visualize a chave novamente após fechar a página de geração de token por motivos de segurança

4. Teste a API usando o Postman ou o cURL

A maneira mais fácil de testar a API é usar o comando cURL, um utilitário que permite utilizar diferentes métodos HTTP para enviar uma solicitação a um servidor, que, neste caso, é o endpoint da API.

Para testar a API usando o cURL, basta abrir o terminal ou o prompt de comando do seu computador e executar a seguinte sintaxe:

curl -X method "URL"  -H "Authentication: API-key"

Substitua method pelo método HTTP real e URL pelo endereço do endpoint. Por exemplo, seu comando pode ficar assim:

curl -X GET "https://developers.hostinger.com/api/vps/v1/virtual-machines"  -H "Authentication: Bearer abcd123efgh456"

Observe que a especificação da sua API pode exigir que você inclua mais informações sobre a solicitação no seu comando. Consulte a documentação da sua API para saber mais sobre suas diretrizes de teste

Outro método popular para testar uma API é usar o Postman. Esse software oferece uma interface gráfica de usuário e recursos mais abrangentes do que o cURL, tornando-o adequado para realizar testes complexos de API com vários endpoints. Veja como fazer isso:

1. Baixe e instale o Postman no seu computador.
2. Abra o cliente Postman. Opcionalmente, crie uma conta se desejar salvar o progresso dos seus testes. Para testes simples, você pode pular o processo de criação de conta.
3. No painel, selecione seu método HTTP preferido.
4. Insira o endpoint da sua API no campo designado.
5. Clique na guia Autorização e selecione o método de autenticação com base na especificação da sua API.
6. Insira as credenciais nos respectivos campos.
7. Clique em Enviar para enviar a solicitação da API.

Se a chamada da API for bem-sucedida, você verá a resposta JSON na parte inferior do seu cliente Postman.

5. Integre a API pública ao seu projeto

A integração da API pública ao seu projeto envolve diferentes etapas, dependendo do tipo de API, da estrutura do seu projeto e da linguagem de programação ou tecnologia que você utiliza

Normalmente, você integra a API no back-end do seu aplicativo e a chama a partir do front-end. Aqui estão os componentes necessários para isso:

• Token de autenticação: a chave da API normalmente reside na variável de ambiente do seu projeto e é chamada no código do seu aplicativo usando o dotenv. Para evitar exposição, os arquivos principais do seu aplicativo não devem conter explicitamente esse token.
• O código do proxy da API: o componente que conecta seu aplicativo ao endpoint da API para buscar dados. Ele também contém os parâmetros que você utilizará na solicitação da API.
• O callback do back-end: a parte do front-end do seu aplicativo que chama a função da API a partir do back-end.
• Código de formatação de dados: o componente do front-end do seu aplicativo que lê e formata os dados JSON buscados.

Por exemplo, temos um site simples em Express.js + HTML que se integra à API da Hostinger para buscar e exibir as métricas dos recursos de hospedagem do seu VPS Linux.

O código do proxy da API tem a seguinte aparência:

app.get('/api/metrics', async (req, res) =&gt; {<br>const { vmId, date_from, date_to } = req.query;<br><br>&nbsp; if (!vmId || !date_from || !date_to) {<br><br>&nbsp; &nbsp; return res.status(400).json({ error: 'Parâmetros ausentes' });<br><br>&nbsp; }<br><br>&nbsp; const url = `${API_BASE_URL}/api/vps/v1/virtual-machines/${vmId}/metrics?date_from=${date_from}&amp;date_to=${date_to}`;<br><br>&nbsp; try {<br><br>&nbsp; &nbsp; const response = await fetch(url, {<br><br>&nbsp; &nbsp; &nbsp; headers: {<br><br>&nbsp; &nbsp; &nbsp; &nbsp; 'Authorization': `Bearer ${BEARER_TOKEN}`<br><br>&nbsp; &nbsp; &nbsp; }<br><br>&nbsp; &nbsp; });

Enquanto isso, a função de callback do back-end tem a seguinte aparência. Ela está localizada no arquivo index.html do nosso site:

const res = await fetch(`/api/metrics?vmId=${vmId}&amp;date_from=${dateFrom}&amp;date_to=${dateTo}`);<br>&nbsp; &nbsp; &nbsp; &nbsp; const data = await res.json();

No index.html, também temos o seguinte código para ler e formatar os dados JSON obtidos em um formato mais simples e legível para humanos:

results.innerHTML = `<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;div class="metric"&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;h3&gt;Utilização da CPU&lt;/h3&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ${data.cpu_usage.usage[ts]} ${data.cpu_usage.unit}<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;/div&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;div class="metric"&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;h3&gt;Uso de RAM&lt;/h3&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ${formatBytes(data.ram_usage.usage[ts])}<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;/div&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;div class="metric"&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;h3&gt;Espaço em disco&lt;/h3&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ${formatBytes(data.disk_space.usage[ts])}<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;/div&gt;

Vários provedores de API também podem oferecer kits de desenvolvimento de software (SDKs) que fornecem ferramentas e bibliotecas pré-configuradas para otimizar o processo de integração. Por exemplo, os SDKs da API da Hostinger permitem que você conecte facilmente nossos serviços de hospedagem às suas aplicações em PHP, Python ou TypeScript.

Onde encontrar APIs públicas?

Vários sites, repositórios e plataformas oferecem um catálogo de APIs públicas. Aqui estão alguns dos mais populares.

• Rapidapi: o maior mercado de APIs públicas do mundo, com mais de 40.000 APIs em várias categorias, incluindo comércio eletrônico, segurança cibernética e mídias sociais. Ele também oferece uma API personalizada com funcionalidades específicas para empresas.
• Free-APIs: um repositório com um extenso índice de APIs de vários desenvolvedores e empresas, incluindo Google e Trello.
• Postman: um portal de APIs públicas altamente popular, com uma ampla seleção de APIs. Oferece documentação abrangente e um recurso integrado para testes, tornando-o adequado caso deseje avaliar uma API em profundidade.
• GitHub: esta plataforma contém vários catálogos de diversas APIs públicas selecionadas pela comunidade. Embora seja excelente para pesquisar APIs de nicho, pode ser difícil de navegar, uma vez que não foi projetada para tal finalidade.

Conclusão

Uma API pública é uma excelente solução para integrar facilmente fontes de dados ricas ou recursos prontos para uso em seu aplicativo

Além de melhorar a eficiência do desenvolvimento, uma API pública ajuda a minimizar erros fatais que podem causar mau funcionamento ou tempo de inatividade, pois você não precisa alterar significativamente o código do seu aplicativo.

Antes de implementar uma API em seu aplicativo, teste-a primeiro para entender melhor como ela funciona. Recomendamos a API da Hostinger para testes e aprendizado, pois ela é gratuita, oferece vários endpoints e possui documentação abrangente. Você também pode integrar a API da Hostinger a aplicativos que suportam o Model Context Protocol (MCP), como o Claude, para habilitar o gerenciamento de hospedagem baseado em IA.

Todo o conteúdo dos tutoriais deste site segue os rigorosos padrões editoriais e valores da Hostinger.

O autor

Ricardo Neto

Esse é Ricardo, o Tradutor e YouTuber da Hostinger Brasil, presente na empresa desde muito cedo tem conhecimento avançado sobre Hospedagem de Sites. Formado em Desenvolvimento de Jogos, teve uma oportunidade em 2015 de começar uma longa jornada de sucesso e parceria com a Hostinger Brasil.

Mais de Ricardo Neto