Início rápido da API
Este guia leva você do zero à primeira requisição bem-sucedida: criar um token pessoal, conhecer o endereço base e chamar um endpoint REST.
Passo 1. Criar um token pessoal
Abra o painel pessoal, seção de tokens pessoais, e crie um novo token (PAT). Copie o valor imediatamente — ele é exibido uma única vez e começa com o prefixo mbp_. Na criação, selecione os escopos de acesso suficientes para sua tarefa; mais detalhes no guia de autenticação.
Passo 2. Endereço base e formato
Todos os endpoints REST ficam sob o prefixo /api. Não há versionamento no caminho. Corpos de requisição e resposta são JSON; envie o cabeçalho Content-Type: application/json para requisições com corpo. O token é transmitido no cabeçalho Authorization: Bearer mbp_….
Passo 3. Primeira requisição — lista de bots
Verifique o token com uma requisição de lista dos seus bots. Para isso é necessário o escopo bots:read (ou *):
curl -H "Authorization: Bearer mbp_SEU_TOKEN" https://seu-dominio/api/bots
A resposta será um array JSON de bots. Se o token for inválido ou expirado, será retornado 401 com o corpo {"error":"..."} (veja erros).
Passo 4. Primeira mutação — criar uma reação
A criação de reação requer o escopo reactions:write. Substitua pelo identificador do bot do passo 3:
curl -X POST -H "Authorization: Bearer mbp_SEU_TOKEN" -H "Content-Type: application/json" -d '{"name":"Olá","trigger":{"type":"command","value":"/start"}}' https://seu-dominio/api/bots/BOT_ID/reactions
Uma resposta bem-sucedida retornará a reação criada com seu id. Os campos exatos do corpo estão na referência interativa — ela gera exemplos prontos em curl, JavaScript e Python para cada endpoint.
Passo 5. Próximos passos — pela referência
Quando o token estiver funcionando, o restante é mais fácil de explorar na referência interativa: lá está a lista completa de endpoints, escopos necessários, esquemas de corpo e o botão "Try it".
Próximos passos
- Autenticação e tokens — sobre PAT, cabeçalho e escopos em detalhes.
- Erros — formato e códigos de status.
- Paginação — como navegar em listas grandes.