Documentation Index — fetch the complete index at nucleopay.com.br/llms.txt

Chaves de API

Aprenda como funcionam as chaves de API e como utilizá-las para acessar a Nucleo Pay.

A chave de API é sua credencial de acesso à Nucleo Pay. Ela identifica sua conta e autoriza cada requisição enviada para a nossa API. Sem uma chave válida, nenhum pedido será aceito.

O que você pode fazer com suas chaves

As chaves de API são gerenciadas diretamente pelo painel. Com elas, você pode:

Demonstração x Produção

Todas as requisições usam o mesmo endpoint https://nucleopay.com.br. O ambiente é definido pela chave utilizada: tokens criados na sua conta real processam PIX de verdade. Use a demonstração interativa para explorar o fluxo sem criar conta.

Erro de Autenticação (401)

Você receberá um HTTP 401 quando: a chave não for enviada no header, a chave estiver incorreta ou a chave tiver sido revogada.

Como enviar a chave

Toda requisição deve incluir o header Authorization:

Authorization: Bearer SUA_CHAVE_API

Boas práticas de segurança

Como criar uma chave de API

  1. Acesse o painel

    Entre em nucleopay.com.br/app e vá em API e Webhooks.

  2. Clique em "Novo token"

    Inicie a criação de uma nova chave de API.

  3. Adicione uma descrição

    Use nomes claros, como "Bot Telegram" ou "Loja principal".

  4. Copie a chave gerada

    Copie e salve em um local seguro ou gerenciador de segredos. Ela não será exibida novamente.

Depois disso, você já pode enviar requisições:

curl -X POST https://nucleopay.com.br/api/pix/charge/create \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Content-Type: application/json" \
  --data '{
    "value": 49.90,
    "title": "Meu produto"
  }'
Endpoint de criação de token: POST /api/auth/token/create com body { "label": "Nome do token" } — requer autenticação Bearer existente.