Autenticação e limitação de taxas

Todos os terminais da plataforma aberta são autenticados uniformemente através da API Key. Esta página explica claramente as três maneiras de escrever Tokens, limites de taxa de pacotes e a semântica das respostas de erro.

Três métodos de escrita de autenticação

1. Autorização: Portador (recomendado)

curl https://braidrun.com/api/v1/workflows \
  -H "Authorization: Bearer dyk_<id>_<secret>"

O método de escrita mais padrão, suportado por todos os SDKs por padrão. O ambiente de produção é preferido.

Cabeçalho 2.X-API-Chave

curl https://braidrun.com/api/v1/workflows \
  -H "X-API-Key: dyk_<id>_<secret>"

Adequado para cenários onde o proxy de algumas redes fechadas não pode encaminhar o Cabeçalho de Autorização. Funcionalmente equivalente ao portador.

3. Parâmetro de consulta ?api key= (apenas em cenários onde o Header não pode ser escrito)

https://braidrun.com/api/webhook-trigger/approval/appr-123/approve?api_key=dyk_<id>_<secret>

Prioridade

1. Authorization: Bearer dyk_…
2. X-API-Key: dyk_…
3. ?api_key=dyk_…

Tente de cima para baixo e pare de analisar quando encontrar um não vazio.

Limitação de débito

Cada API Key tem dois limites superiores de "por minuto" e "diário", que são automaticamente aplicados de acordo com o pacote do proprietário da Chave. Cada chave tem uma quota independente e não é compartilhada com outras chaves na mesma conta.

Tabela de comparação de pacotes

Semântica da janela

• janela do minuto · Use minutos de época como chave, e o limite é reiniciado automaticamente a cada minuto (não a janela deslizante a partir da primeira chamada)
• diariamente (janela do dia) · Usar a data UTC como chave, reiniciar automaticamente às 00:00 UTC todos os dias

Quando o limite for atingido

HTTP/1.1 429 Too Many Requests
Retry-After: 38
X-RateLimit-Limit: 60
X-RateLimit-Window: minute
Content-Type: application/json

{
  "error": "Rate limit exceeded",
  "window": "minute",
  "limit": 60,
  "retryAfterSeconds": 38
}

O cliente deve:

• Leia o Cabeçalho de Repetição (número de segundos), atrase o tempo correspondente e tente novamente
• X-RateLimit-Window Diz- lhe qual a janela atingida (minuto/dia)
• Retrocesso exponencial + jitter; não tente imediatamente após receber 429

Código de resposta HTTP