falafy
PT
Baixar grátis

API pública v1 · @falafy/bot

Construa no Falafy

Bots, comandos de barra, botões, webhooks e “entrar com o Falafy”. Tudo por uma API pública versionada, com SDK oficial em TypeScript.

O que dá para fazer

  • Bots que entram em servidores com um cargo próprio e respondem a mensagens e comandos.
  • Comandos de barra (/dado), com opções tipadas, escolhas e autocomplete, além de menus de usuário e de mensagem.
  • Componentes: botões e menus de seleção nas mensagens do app, e formulários (modais).
  • Respostas efêmeras (só quem usou vê) e respostas adiadas (“pensando…”) com follow-ups por 15 minutos.
  • Webhooks para postar avisos de CI, monitoramento ou formulários em um canal, com embeds.
  • OAuth2 para “entrar com o Falafy” no seu site (código + PKCE).

Como funciona

Cada aplicação é criada em Configurações > Desenvolvedor no app (ou em falafy.com.br/app/dev) e ganha um usuário-bot, um token, um segredo de cliente e uma chave pública Ed25519. A API REST fica em https://falafy.com.br/api/v1; eventos chegam pelo gateway WebSocket ou, para interações, por HTTP assinado no seu servidor.

IDs são UUIDs (versão 7, ordenáveis pelo tempo). Datas seguem ISO 8601. Os campos JSON usam camelCase.

Por onde começar

  1. Início rápido: crie o app, instale e rode um bot em minutos.
  2. Referência da API: todas as rotas v1.
  3. Gateway e intents: eventos em tempo real.
  4. Interações: comandos, componentes, modais.
  5. Webhooks, OAuth2 e limites e erros.

Regras do jogo

Bots obedecem às mesmas permissões das pessoas (o cargo do bot + as regras de cada canal), não podem mandar DM para quem não divide servidor com eles (a não ser que a pessoa tenha autorizado o app) e todas as ações administrativas ficam no registro de auditoria do servidor. Tokens e segredos aparecem uma única vez e ficam guardados só como hash.