Autenticação e limites

Chaves de API Bearer que atuam como um utilizador de serviço — seguras, revogáveis e com limite de pedidos.

Visão geral

Autentica cada pedido com uma chave de API Bearer. Cada chave atua como um utilizador de serviço à tua escolha, herdando as roles, regras de registo e permissões de campo desse utilizador — por isso uma chave nunca pode fazer mais do que esse utilizador faria na app.

As chaves são criadas na app em Definições → Chaves de API (planos Pro e Enterprise). O segredo é mostrado uma vez; as chaves são revogáveis, podem expirar e têm limite de pedidos por chave.

O que podes fazer

Atua como utilizador de serviço

Define o âmbito de uma chave com precisão escolhendo que utilizador representa e a role desse utilizador.

Revogável e com expiração

Revoga uma chave instantaneamente, ou define uma data de expiração ao criá-la.

Com limite de pedidos

Cada chave tem um limite por minuto (default 120); exceder devolve 429 com Retry-After.

Referência

Envia a chave como Bearer token; trata os erros com os códigos abaixo.

# Every request carries a Bearer API key
curl https://api.megorix.com/data/hr/employees \
  -H "Authorization: Bearer mgx_live_xxxxxxxxxxxxxxxx"

# A rate-limited response (HTTP 429)
# Retry-After: 23
{ "success": false,
  "error": { "code": "api_key.rate_limited", "message": "..." } }

Erros

401

api_key.missing / api_key.invalidMissing, invalid, revoked or expired key

403

plan.feature_not_availableThe plan does not include API access

403

auth.missing_permissionsThe service user lacks the permission

404

(varies)Entity or record not found

429

api_key.rate_limitedRate limit exceeded — see the Retry-After header

Experimenta agora

Abre a referência interativa da API e faz a tua primeira chamada em minutos.

Referência da API Ver planos