
A página API no dashboard do seu app
Abrindo a página de API
A página de API fica no dashboard do app, ao lado dos dados e logs do seu app. Para abrir a página de API:- Clique em Painel no editor do app.
- Clique em API.
- Escolha uma linguagem no menu suspenso no topo da página: JS SDK, JS Fetch, cURL ou Python.
O que há na página
A página é dividida em seções, e cada exemplo de código é atualizado quando você muda a linguagem:- Autenticação: Como outras ferramentas fazem login no seu app. As requisições usam um token de acesso pessoal. Se você ainda não tem um, clique em Criar token de acesso nesta seção. Se você escolheu JS SDK, esta seção também mostra como instalar o SDK da Base44 e configurá-lo com o ID do seu app e seu token.
- Endpoints de Entidades: Cada tabela do seu app, com seu Schema e Endpoints lado a lado. Clique em Copiar entidade para copiar a referência de uma tabela, ou em Copiar tudo para copiar todas as tabelas. Para copiar código para ler ou atualizar uma tabela, veja conectando seus dados a outro app.
- Funções Backend: Como executar as funções de backend do seu app a partir de outra ferramenta. Para que um serviço como o Stripe chame uma função quando algo acontece, veja recebendo webhooks.
- Agente do App: Como conversar com o agente do seu app, por exemplo iniciando uma conversa, enviando mensagens e recebendo respostas.
É bom saber:
- Uma entidade é uma tabela de dados no seu app, como Tarefas ou Pedidos.
- Um endpoint é o endereço para o qual outra ferramenta envia uma requisição.
- Um token de acesso funciona como uma senha para a API do seu app.
- OpenAPI é um formato de arquivo padrão que ferramentas de API entendem.
Obtendo ajuda da IA
A maneira mais fácil de usar a API do seu app é deixar um assistente de programação com IA escrever o código para você. Copiar para IA copia a referência completa da API do seu app em um formato que ferramentas de IA entendem, para que o código gerado corresponda ao seu app. Para que um assistente de IA escreva código para a API do seu app:- Clique em Painel no editor do app.
- Clique em API.
- Clique em Copiar para IA.
-
Cole no seu assistente de programação com IA e descreva o que você quer criar. Por exemplo:
- Quando o código estiver pronto, clique em Criar token de acesso na página de API e adicione o token onde o código pedir.
Baixando a especificação OpenAPI
Baixe a referência de API do seu app como um arquivo OpenAPI para usá-la em um cliente de API ou ferramenta de documentação. Para baixar a especificação OpenAPI:- Clique em Painel no editor do app.
- Clique em API.
- Clique no ícone Mais ações .
- Clique em Baixar especificação OpenAPI.
A página de API mostra seu app como ele está quando você a abre. Depois de adicionar ou alterar tabelas, funções de backend ou agentes, atualize a página para ver a mudança na referência e em todos os arquivos que você exportar.
Recebendo webhooks
Um webhook é uma mensagem que outro serviço envia ao seu app quando algo acontece. Por exemplo, o Stripe avisa que um pagamento foi concluído. Para receber webhooks, você informa ao serviço a URL de uma das funções de backend do seu app. A função é executada sempre que uma mensagem chega. Você não precisa configurar webhooks para os pagamentos integrados da Base44. Se você configurar o Stripe pelo chat de IA, ele registra o webhook do Stripe e salva o segredo de assinatura para você quando seu fluxo de pagamento precisar. Saiba mais em Configurando o Stripe. Cada função de backend tem sua própria URL pública, neste formato:base44/functions. Use aqui o endereço base44.app do seu app, mesmo que você tenha conectado um domínio personalizado.
Os serviços enviam webhooks sem fazer login no seu app, então a função não pode depender de um usuário conectado. Qualquer pessoa com a URL pode chamá-la. Por isso, a função deve verificar a assinatura de cada mensagem antes de fazer qualquer coisa. Sua função recebe o corpo e os cabeçalhos originais da requisição. É disso que a maioria dos serviços, incluindo o Stripe, precisa para essa verificação.
Para receber webhooks de um serviço:
-
Peça ao chat de IA no editor do app para criar uma função para o webhook e cite os eventos que ela deve tratar. Por exemplo:
- Copie a URL da função. O chat de IA informa a URL, ou você pode montá-la com o formato acima.
- Adicione a URL como um endpoint de webhook no painel do serviço e escolha os mesmos eventos. Para o Stripe, consulte o guia de webhooks do Stripe.
- Copie o segredo de assinatura que o serviço mostra para o endpoint.
-
Adicione-o ao seu app como um segredo, usando o nome que sua função espera, como
STRIPE_WEBHOOK_SECRET.
Publique seu app quando terminar. Os webhooks sempre executam a versão da função do seu app publicado, com os segredos que ele tinha na última publicação. Publique novamente sempre que mudar algum deles.
Solucionando problemas de webhooks
A maioria dos problemas de webhook vem do segredo da função, das verificações de login dela ou de um app que ainda não foi publicado. Se os webhooks não estão chegando à sua função, encontre sua situação abaixo.Meu webhook do Stripe recebe um erro 401
Meu webhook do Stripe recebe um erro 401
A Base44 verifica cada webhook do Stripe com os segredos de assinatura do Stripe salvos no seu app antes de a função ser executada. Ela rejeita a requisição se nenhum segredo de assinatura estiver salvo ou se nenhum deles corresponder.Adicione o segredo de assinatura deste endpoint como um segredo no seu app e depois publique seu app. Cada endpoint do Stripe tem seu próprio segredo de assinatura, começando com
whsec_. Endpoints de teste e de produção têm segredos diferentes.Meu webhook recebe um erro 403
Meu webhook recebe um erro 403
A função verifica se há um usuário conectado ou uma chave de API, algo que os serviços que enviam webhooks não podem fornecer. Peça ao chat de IA para alterar a função para que ela não exija login e verifique a assinatura do webhook.Saiba mais em solução de problemas de funções de backend.
Meu webhook recebe um erro 404, ou minhas alterações não aparecem
Meu webhook recebe um erro 404, ou minhas alterações não aparecem
Os webhooks só chegam a funções do seu app publicado. Verifique se a URL usa o nome exato da função e depois publique seu app para que a versão mais recente da função fique no ar.
Se os webhooks ainda não funcionarem, fale com o Customer Care. Inclua o link do seu app, o nome da função e o serviço que envia os webhooks.
Indo além
Se você é desenvolvedor, a documentação para desenvolvedores cobre a API do seu app e o SDK da Base44 em profundidade.Visão geral do SDK da Base44
Configure o SDK e aprenda como ele funciona com seu app.
Trabalhando com dados
Leia, crie, atualize e exclua registros nas tabelas do seu app a partir do código.
Entidades
Defina e proteja as tabelas por trás da API do seu app.
Tokens de acesso pessoal
Crie e gerencie os tokens que seus scripts e ferramentas usam para fazer login.
Esta página foi traduzida usando IA. Para as informações mais precisas e atualizadas, consulte a versão em inglês.