Integrações
Conecte qualquer API
Use serviços que não estão no catálogo de Conectores, de APIs públicas a serviços que pedem uma chave, ou crie seu próprio conector para a IA usar nas criações.
O catálogo de Conectores reúne mais de 100 serviços, mas seu app pode funcionar com quase qualquer serviço que tenha uma API (um jeito de outros programas conversarem com ele). Esta página mostra as três formas de fazer isso, da mais rápida à mais reutilizável.
| Sua situação | O que fazer |
|---|---|
| A API é pública e não precisa de chave | Peça no chat |
| A API precisa de uma chave, e você só vai usá-la em um app | Deixe a IA pedir a chave, e ela fica salva como um segredo daquele app |
| Você vai usar o serviço em vários apps, ou quer que a IA entenda bem como ele funciona | Crie seu próprio conector na página Conectores |
Qualquer que seja a sua escolha, as chaves só são usadas no código de servidor do seu app. Assim, elas não vão parar no navegador de quem visita seu app.
Use uma API pública
Muitos serviços, como previsão do tempo, feriados ou dados abertos, não precisam de chave nenhuma. Diga o nome do serviço e o que você quer dele.
Mostra na página inicial a previsão do tempo dos próximos 5 dias na cidade do visitante, usando a API Open-Meteo.
Se a IA precisar de detalhes sobre uma API que ela não conhece bem, cole no chat a parte importante da documentação, como um exemplo de requisição e a resposta que ela devolve. Você também pode anexar a documentação como arquivo. Veja Adicione imagens e arquivos.
Use uma API que precisa de chave
Quando um recurso precisa de uma chave de um serviço que não está no catálogo, a IA mostra no chat um cartão de chave com o nome que ela vai usar, por exemplo ACME_API_KEY. Cole a chave e clique em Salvar, ou clique em Pular para seguir sem ela.
O próprio cartão explica: a chave é salva com segurança e criptografada, nunca aparece no chat nem no código do seu app, e você pode trocá-la depois em Gerenciar → Segredos (os colegas de equipe veem um aviso de que quem pode trocá-la é o proprietário do projeto).
Coloca um formulário de contato que cria um novo lead no nosso CRM pela API dele. Me pede a chave da API.
Você também pode adicionar chaves por conta própria, antes de pedir: abra a aba Gerenciar, escolha Segredos e adicione uma em Adicionar novo segredo. A prévia recebe as mudanças automaticamente; seu app publicado, na próxima vez que você publicar. Veja Segredos e chaves de API.
Não digite chaves em uma mensagem do chat. As mensagens do chat ficam salvas junto com o seu projeto. Use o cartão de chave ou Gerenciar → Segredos.
Crie seu próprio conector
Se você vai usar um serviço em mais de um app, ou quer que a IA entenda bem a API dele, adicione-o como seu próprio conector. Você descreve a API uma vez só. Depois disso, ele funciona como qualquer conector do catálogo: você o conecta com a sua chave, liga ou desliga por app, e a IA pode criar com ele e consultá-lo enquanto cria.
Na página Conectores, role até Seus próprios conectores e clique em Criar conector. Deixe a documentação da API do serviço aberta, porque você vai precisar do endereço da API e de como ela recebe a chave. Nenhuma chave entra na descrição em si: você conecta a sua no final.
Detalhes
Dê um Nome ao conector. Se quiser, adicione uma Descrição curta para o cartão e O que ele faz (isso ajuda a IA a saber quando usá-lo). Depois escolha uma Categoria, adicione um Link da documentação da API (opcional) e escolha uma Cor. O Nome no código define os nomes das configurações que seus apps leem, como
ACME_CRM_API_KEY. Ele não pode ser mudado depois.Como ele faz o login
Digite o Endereço da API, onde toda requisição começa (ele precisa começar com
https://). Depois responda Como o serviço confirma quem é você?: Token Bearer, Chave de API em um cabeçalho, Chave de API no endereço ou Usuário e senha. Se o serviço precisar de mais de um valor, como o ID de uma conta, adicione-os em Precisa de mais de um valor?. Uma prévia mostra Como fica uma requisição.Requisição de teste
Escolha uma requisição que só leia dados e precise da chave, como "quem sou eu" ou "listar meus itens". A Buildliy roda essa requisição para conferir cada chave antes de salvá-la, então ela não pode mudar nada. Em Experimente (opcional) você pode colar uma chave e clicar em Executar requisição de teste para ver a resposta. Essa chave só é usada no teste e não é salva, a menos que você se conecte com ela depois.
Quem vê os dados
Escolha Só eu — é pessoal para dados privados de uma conta (sua caixa de entrada, suas anotações ou seu banco), ou Qualquer pessoa que use meu app — é compartilhado para dados feitos para todo mundo, como uma lista de produtos ou anúncios públicos.
Notas para a IA
Se quiser, cole as partes da documentação da API que a IA deve conhecer: endpoints, exemplos de requisições e de respostas. Dê a cada nota um Nome do arquivo e, se quiser, diga Quando a IA deve ler isto? Você pode adicionar até 10 notas de 20.000 caracteres cada. A IA vê o começo de cada nota e lê o resto quando precisar. Nunca cole chaves aqui.
Clique em Criar conector. Em seguida, a janela de conexão se abre, já com a chave que você digitou em Experimente (opcional) preenchida. Digite sua chave, se precisar, e clique em Conectar. A Buildliy executa sua requisição de teste com a chave antes de salvá-la e depois a guarda criptografada. Ela só é usada no código de servidor dos seus apps.
Usa meu conector do Acme CRM pra mostrar meus 20 contatos mais recentes numa página de painel, com uma caixa de busca.
Cada um dos seus próprios conectores tem um cartão com Conectar (Gerenciar depois de conectado, ou Reconectar se a chave parar de funcionar), Editar e um botão de excluir. Ao excluir, o conector e a sua chave salva para ele são removidos, e os apps que o usam deixam de conseguir acessar o serviço até você adicioná-lo de novo. Você pode ter até 25 conectores próprios.
Se você escolheu Só eu — é pessoal, a IA deixa tudo o que vem desse serviço protegido pelo login do seu app. Depois que ele estiver conectado, o checklist de lançamento bloqueia a publicação se o código do seu app usar esse conector e o app não tiver login. Se o app tiver login, o checklist lembra você de garantir que só você (ou as pessoas que você escolher) consiga entrar, porque um cadastro aberto deixaria qualquer pessoa ver os dados.
Receba eventos de um serviço
Alguns serviços podem enviar uma mensagem para o seu app quando algo acontece, como um novo pedido ou um pagamento concluído. Essas mensagens costumam ser chamadas de webhooks. Peça à IA para adicionar ao seu app um lugar para recebê-las. Se o serviço fornecer um segredo de assinatura para conferir se as mensagens são verdadeiras, a IA pede esse segredo com um cartão de chave.
Cria um endpoint de webhook que receba os eventos de pedido novo do nosso sistema de estoque e salve cada pedido no banco de dados.
Dê ao serviço o endereço do seu app publicado, não o da prévia, porque a prévia nem sempre está funcionando. Veja Publique seu app.
Veja também
Ainda com dúvida? Leia as Perguntas frequentes ou fale com a gente.