Primeiros passos

Autenticação

A API autentica cada requisição por uma chave de API enviada no header x-api-key. As chaves carregam o Merchant, o ambiente e os escopos permitidos.

A chave de API

Gere suas chaves na seção Desenvolvedores do dashboard. O valor completo só é exibido no momento da criação, guarde-o em local seguro. Chaves de produção (LIVE) seguem o formato sk_live_….

Mantenha suas chaves em segredo

Nunca exponha a chave em código de frontend, repositórios públicos ou no navegador. Use sempre a partir do seu servidor. Se uma chave vazar, revogue-a imediatamente no dashboard.

Enviando a chave

Inclua o header x-api-key em toda chamada. Requisições sem chave válida retornam 401.

Escopos

Cada chave tem escopos que limitam o que ela pode fazer. Uma chave sem o escopo exigido pelo endpoint recebe 403.

charge:write: criar cobranças.
charge:read: consultar cobranças.

Princípio do menor privilégio

Crie chaves separadas por finalidade. Um serviço que só consulta status precisa apenas de charge:read.

Exemplo autenticado

curl https://apiv2.onnixpay.com/v1/charges/019e8f03-2d48-7f9b-9d8e-eb22404754b2 \
  -H "x-api-key: sk_live_sua_chave_aqui"

Sem chave válida

{
  "code": "API_KEY_UNAUTHORIZED",
  "message": "Chave de API inválida ou ausente."
}

Escopo insuficiente

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "A chave de API não possui o escopo necessário: charge:write"
}

AnteriorIntrodução Próximo Ambientes