Pular para o conteúdo

Primeiros passos

No painel da Auryon, abra Integrações → API → Gerar credencial. Dê um nome e marque só as permissões de que o seu sistema precisa (veja Autenticação).

A chave secreta aparece uma única vez. Guarde-a num cofre de segredos, nunca no código nem no navegador. Você pode ter até 5 credenciais ativas e revogar qualquer uma a qualquer momento.

/v1/ping não precisa de credencial. Serve para saber que você chegou à Auryon:

Janela do terminal
curl https://api.auryon369.com.br/v1/ping
{ "ok": true, "service": "auryon369", "version": "v1" }
Janela do terminal
curl https://api.auryon369.com.br/v1/credentials \
-H "x-public-key: $AURYON_PUBLIC_KEY" \
-H "x-secret-key: $AURYON_SECRET_KEY"

A resposta diz o que a credencial pode fazer:

{ "seller_id": "01a1…", "permissions": ["PRODUCER_DATA", "PRODUCER_TRANSACTIONS"] }
Janela do terminal
curl "https://api.auryon369.com.br/v1/transactions?page=1&page_size=20" \
-H "x-public-key: $AURYON_PUBLIC_KEY" \
-H "x-secret-key: $AURYON_SECRET_KEY"

Para achar a venda de um pedido seu, filtre pelo identifier que você enviou na criação: /v1/transactions?identifier=SEU-PEDIDO-123.

Não consulte a API em laço para saber se uma venda foi paga. Cadastre um webhook em Integrações → Webhooks, assine transaction.paid e libere o acesso quando ele chegar. Veja Webhooks.

  • Dinheiro: inteiro na menor unidade da moeda, como string. "19900" em BRL é R$ 199,00. A escala vem da moeda (2 casas no BRL e no USD). String porque um número JSON grande perde precisão em várias linguagens.
  • Datas: ISO 8601 em UTC (2026-09-17T12:00:00.000Z).
  • Paginação: page (a partir de 1) e page_size (padrão 20, máximo 100; acima disso o servidor limita a 100). A resposta traz items, page, page_size e total.
  • Dados do comprador: a API e os webhooks levam o nome e o e-mail, que é o necessário para entregar o produto. CPF, telefone e endereço não saem da Auryon.
  • Saldo por moeda: BRL, USD e BDM nunca se somam; /v1/balance devolve uma lista, uma linha por moeda.