Skip to main content

Rate limit

Para manter a estabilidade do serviço, a RyzeAPI aplica um limite de requisições por minuto. O limite é contado por token: todos que usam o mesmo token compartilham o mesmo balde.
Se você precisar de um limite maior para sua conta, entre em contato com o suporte.

Cabeçalhos de rate limit

Todas as respostas (inclusive as bem-sucedidas) trazem três cabeçalhos que permitem ao seu cliente se adaptar:
Use X-RateLimit-Remaining para implementar backoff exponencial antes de bater no limite. Por exemplo: quando ficar abaixo de 10, espere um pouco antes da próxima chamada.

O que acontece quando estoura

A API responde com HTTP 429 Too Many Requests:
Os cabeçalhos X-RateLimit-* continuam sendo enviados, use X-RateLimit-Reset para saber quando pode tentar de novo.

Exemplo de tratamento

CORS

Se você está chamando a API de um navegador (JavaScript rodando em uma página web), precisa se atentar ao CORS.

Origens permitidas

A RyzeAPI aceita requisições vindas apenas das origens autorizadas para a sua conta. Origens não autorizadas recebem o erro clássico de CORS no console do navegador:
Se sua aplicação frontend precisa chamar a RyzeAPI, peça ao suporte para adicionar a sua origem (https://meusite.com) na allowlist da sua conta.

Métodos e headers aceitos

A API responde ao preflight (OPTIONS) com os seguintes cabeçalhos:
Você pode enviar requisições com qualquer método HTTP usado pela API e com os headers Content-Type, Authorization ou token.

Sem cookies

A RyzeAPI não usa cookies para autenticação, o token vai no header token. Por isso, não é necessário (e não é suportado) enviar credentials: "include" nas requisições fetch.

WebSocket em navegador

Como JavaScript no browser não permite customizar headers em new WebSocket(...), a única forma de autenticar é pela query string:
O WebSocket também segue a allowlist de origens da sua conta.

Checklist

Implemente backoff com base em X-RateLimit-Remaining para não ser bloqueado.
Trate HTTP 429 com re-tentativa após X-RateLimit-Reset.
Se usa browser, peça ao suporte para adicionar sua origem na allowlist.
Para WebSocket em browser, passe o token via ?token= na URL.