API
Forma de conectar programas a um modelo de IA - como um “plugue” para criar seus próprios aplicativos.
API, ou interface de programação de aplicações, é uma forma padronizada de um programa usar funções ou dados de outro sem precisar clicar manualmente na interface.
Uma loja pode usar uma API para consultar a cotação do dólar e exibi-la no próprio painel. Em vez de copiar o valor de uma página, a pessoa recebe uma resposta organizada com o código da moeda, a data e a cotação. É um bom exemplo para começar, pois não exige um modelo de IA nem o envio de dados de clientes. API, por si só, não significa inteligência artificial.
Como fazer sua primeira solicitação a uma API
Abra no navegador o endereço https://api.nbp.pl/api/exchangerates/rates/a/eur/?format=json. Esse é um endpoint público, ou seja, o endereço de uma função específica: consultar a cotação média mais recente do EUR na tabela A. A resposta inclui, entre outros campos, effectiveDate, com a data de publicação, e mid, com a cotação. Em fins de semana, a data pode não ser a do dia atual.
Essa consulta de dados é uma solicitação GET. Um programa pode executá-la automaticamente e ler os campos necessários em JSON, um formato de dados em texto. Para enviar conteúdo a um modelo de IA, costuma-se usar POST: além do endereço, a solicitação inclui cabeçalhos e um corpo. O formato exato é sempre definido pelo provedor. A documentação da API descreve os parâmetros, os intervalos de datas e as respostas de erro.
Para praticar, escolha uma cotação e uma data. Veja o que o aplicativo faz se a resposta não chegar ou se a tabela indicada ainda não existir. Nesse caso, não substitua o valor por zero, pois isso parece um número válido. Mostre que os dados estão indisponíveis ou exiba a última consulta com a respectiva data. Essa habilidade é mais importante do que simplesmente copiar um endereço que funciona.
Para que serve uma API em projetos com IA
Por exemplo, uma pequena empresa recebe mensagens em português brasileiro e quer classificá-las em dúvidas sobre entrega, devoluções e outros assuntos. O programa pode enviar um texto anonimizado ao modelo e pedir que ele indique uma categoria. Depois, salva o resultado no painel. Ainda é preciso verificar a resposta do modelo: ela deve corresponder a uma das categorias permitidas, e não acionar diretamente um reembolso.
Uma API permite integrar um modelo ao seu próprio formulário, planilha ou aplicativo. Mas ela não garante que as respostas estejam corretas. O chat disponível no navegador e a API do provedor podem ter preços, limites e regras de acesso diferentes. Antes de conectar o serviço aos dados da empresa, confira as condições da API, não apenas a oferta de assinatura do chat.
Como configurar uma integração passo a passo
-
Defina uma tarefa e o formato do resultado. Para começar, basta classificar cinco mensagens de exemplo, sem nomes nem dados de pedidos.
-
Consulte a documentação de autenticação. Se precisar de uma chave de API, guarde-a no servidor. Não a insira no código público do site, em capturas de tela nem em repositórios. Nem todas as APIs exigem uma chave - a consulta acima não exige.
-
Defina um tempo limite e o tratamento de erros. Uma resposta 401 geralmente indica um problema de autenticação, enquanto 429 indica que um limite foi excedido. Consulte a documentação e a mensagem para ver os detalhes. Não repita uma solicitação paga indefinidamente: se a conexão for interrompida, o serviço pode já ter processado o pedido.
-
Registre o custo, o status e o tempo de execução, mas não segredos nem o conteúdo completo de mensagens privadas. Limite o número de tentativas, o tamanho da entrada e o resultado máximo. Confira se o limite de gastos do provedor bloqueia operações ou apenas envia uma notificação.
-
Teste com um texto vazio, sem conexão e com uma resposta inválida. Só passe a processar muitos registros depois de verificar uma pequena amostra.
Erro comum: tratar a API como um aplicativo pronto
A API dá acesso a funções, mas não cria todo o processo. Alguém precisa validar os dados de entrada, lidar com falhas do serviço, proteger a chave e decidir o que fazer com o resultado. Uma biblioteca ou SDK facilita a escrita desse código, mas não é outro nome para API. A introdução da MDN explica a diferença entre uma interface e uma biblioteca.