Conta

Duas rotas pequenas que ajudam a testar a integração: uma diz se a API está no ar, a outra diz quem você é para a API. Nenhuma devolve dado de negócio.

Escopo exigido: nenhum. GET /v1/health não pede credencial; GET /v1/me aceita qualquer credencial válida.

Testar na referência interativa

Verificar se a API está no ar

GET /v1/health

Responde 200 quando a API está no ar. Não exige Authorization e não traz dados da empresa. Serve para monitoramento simples e para confirmar que o seu servidor alcança a API.

curl https://platform.festero.com.br/v1/health

{
  "status": "ok",
  "version": "1.0.0"
}

Campo	Descrição
status	Sempre ok quando a API responde.
version	Versão da compilação da API em execução. Informativa: não use para decidir comportamento.

Identificar a credencial

GET /v1/me

Devolve a credencial usada na chamada. É a primeira chamada recomendada depois de criar uma credencial: se ela funciona, o token, a credencial e o plano estão certos.

curl https://platform.festero.com.br/v1/me \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "credentialId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "workspaceId": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "scopes": ["crm:read", "events:read"],
  "tier": "PREMIUM",
  "authKind": "jwt"
}

Campo	Descrição
credentialId	Identificador da credencial.
workspaceId	Identificador da empresa dona da credencial.
scopes	Escopos concedidos à credencial, em ordem alfabética e sem o prefixo festero-api/.
tier	Plano da credencial: PREMIUM ou ENTERPRISE. Define os limites de uso.
authKind	Como a chamada foi autenticada: jwt para um token de acesso, mcp_key para uma chave MCP.

Campos que pedem atenção

• scopes mostra o que a credencial pode ler. Se uma rota responder scope_missing, confira aqui se o escopo está na lista.
• Esta é a única rota de dados que uma credencial ainda Ativando consegue chamar. Se ela responder 200 mas as demais responderem credential_revoked, espere a credencial ficar Ativa na tela API do Festero.
• tier vem em maiúsculas, diferente dos status das outras rotas.

Erros possíveis

Rota	Código	HTTP	Quando
GET /v1/me	token_invalid	401	Token ausente, malformado ou inválido.
GET /v1/me	token_expired	403	Token com mais de 60 minutos.
GET /v1/me	credential_revoked	401 ou 403	Credencial revogada, expirada ou suspensa.
GET /v1/me	plan_required	403	O plano da empresa não inclui a API.

Testar na referência interativa