Como gerar API Key
A API Key é gerada no painel do OnnixPay. Siga o passo a passo abaixo para criar e configurar sua chave.
Passo a passo
- Acesse o painel — Faça login em (URL do painel: definir).
- Área de integração — No menu, abra "Integração" ou "API".
- Criar nova chave — Clique em "Criar API Key" e escolha o ambiente (Produção ou Sandbox).
- Definir escopos — Marque apenas os escopos necessários para sua aplicação (veja a tabela abaixo).
- Copiar e guardar — A chave será exibida uma única vez. Copie e armazene em local seguro.
Boas práticas de segurança
Armazene a chave em variáveis de ambiente (ex:
ONNIXPAY_API_KEY). Rotacione as chaves periodicamente e nunca as exponha no frontend ou em repositórios públicos.Escopos disponíveis
Ao gerar a API Key, você pode limitar as permissões por escopo. Use o mínimo necessário para sua aplicação.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| transactions:read | string | Sim | Leitura de transações |
| transactions:write | string | Sim | Criação e atualização de transações |
| pix:read | string | Sim | Leitura de cobranças e dados PIX |
| pix:write | string | Sim | Criação de cobranças e pagamentos PIX |
| accounts:read | string | Sim | Consulta de saldo e extrato |
| webhooks:read | string | Sim | Listagem e histórico de webhooks |
| webhooks:write | string | Sim | Configuração de webhooks (definir) |