Waafir
Esta página é uma tradução automática pendente de revisão humana. Pode conter erros.

API da plataforma (/v1)

A API da plataforma é a interface HTTP versionada do Waafir. Use-a para ler e gerenciar sua organização a partir dos seus próprios sistemas. Ela abrange sua equipe (convidar membros, alterar funções, removê-los), concessões de acesso a salas de dados, pastas, arquivos, Q&A, chat e agentes da sala de dados, atividade e engajamento por contraparte, e o monitoramento de portfólio.

Ela é uma superfície separada dos servidores MCP do Waafir, que expõem a mesma plataforma a clientes de IA como ferramentas. Ambas se autenticam com os mesmos tokens de acesso pessoal.

URL base

Todos os endpoints ficam em:

https://app.waafir.io/api/v1

A referência de endpoints lista cada um pelo caminho completo, por exemplo GET /api/v1/team.

Sua primeira chamada

  1. Emita um token. No Waafir, abra Complementos → Configuração e emita um token de acesso pessoal. Um token read basta para começar. Copie o valor, que começa com waafir_pat_. Ele é exibido apenas uma vez.
  2. Pergunte quem você é. GET /api/v1/session retorna a identidade e a organização em nome das quais o token atua. Use-o para verificar se um token funciona antes de construir sobre ele:
curl -s https://app.waafir.io/api/v1/session \
  -H "Authorization: Bearer $WAAFIR_TOKEN"
{
  "orgId": "…",
  "userId": "…",
  "email": "you@example.com",
  "orgRole": "admin",
  "authMethod": "pat",
  "principalType": "user"
}

Um 401 significa que o token está ausente, foi digitado incorretamente, expirou ou foi revogado. Outras recusas geralmente trazem um code legível por máquina, explicado na página de códigos de erro. Algumas não trazem nenhum, então sempre recorra ao status HTTP.

Como a referência é gerada

As páginas de endpoints e de códigos de erro são geradas a partir da própria árvore de rotas da plataforma toda vez que este site é publicado. Elas não são escritas à mão. Uma versão de produção as gera a partir do mesmo commit que o app, de modo que listam as rotas que essa versão atende, com a restrição de função e o escopo de token que cada endpoint exige e os parâmetros de consulta que ele aceita. As listas de erros são um mínimo conhecido, não exaustivo: um endpoint pode retornar códigos que o gerador não enxerga, então trate erros não listados pelo status HTTP.

Versionamento

/v1 é aditiva dentro da sua versão. O Waafir pode adicionar campos de resposta e parâmetros de solicitação opcionais. Ele não remove nem altera o tipo de um campo existente, nem remove um endpoint, dentro de /v1. Uma alteração incompatível é lançada sob um novo prefixo de versão. Escreva clientes que ignorem os campos que não reconhecem.

Próximos passos