Pular para o conteúdo principal

API & SDK

Abra Integrations & APIs → API & SDK após selecionar um workspace. Produção oferece API keys e REST reference.

Chaves API​

Clique em Create key, dê um nome e selecione ao menos um escopo permitido pelo seu papel: read, write, analytics, webhooks ou admin. Copie a chave completa imediatamente: ela aparece uma única vez. Depois, a tabela mostra apenas valor mascarado, escopos, requisições, último uso, criação e autor. Revogue pelo menu da linha.

Os cartões mostram consumo mensal e limite do plano. A interface usa por padrão 50 requisições por segundo e burst de 100, mas o deploy pode sobrescrever esses números; considere os valores exibidos como fonte oficial.

Referência REST​

REST reference carrega o catálogo de /v1/api-reference. Selecione um endpoint para ver método, caminho, resumo, autenticação, escopo, cURL e resposta. Use esse painel atual, não uma lista estática. Nunca exponha chaves no navegador.

Documentos relacionados​

Perguntas frequentes​

Posso recuperar uma chave perdida?

Não. Revogue-a, crie outra com escopos mínimos e atualize a integração.

Qual é o limite?

Consulte o cartão em API keys. O padrão é 50/s e burst 100, mas o deploy pode alterá-lo.

Onde está a lista de endpoints?

Em API & SDK → REST reference, carregada do catálogo atual do servidor.