API Admin › Referência

O token e a loja

Endereço base: https://api.denaryx.com/admin/2026-10. Exemplos e regras no guia O token e a loja. Os erros seguem o formato comum. A especificação inteira: baixar o OpenAPI.

GET /token

O token que faz a chamada

Escopo Qualquer token da loja

A integração, o token, os escopos marcados no painel, a versão e o limite de chamadas. Serve para conferir a configuração antes de começar. Com o token de uma sessão do CLI (o login pela conta da pessoa), integration vem null, session traz o aparelho e user a pessoa, e os escopos são os que o papel dela na loja dá agora.

Resposta

200 Sucesso. (Token)

Os campos da resposta (24)
CampoTipoDescrição
integrationobjeto ou null
integration.idstring (uuid)
integration.namestring
integration.api_versionstringUm de: 2026-10.
integration.approval_modestringUm de: direct, proposal.
integration.created_atstring (data e hora)
tokenobjeto
token.idstring (uuid)
token.expires_atstring (data e hora) ou null
token.created_atstring (data e hora)
sessionobjeto ou null
session.idstring (uuid)
session.devicestring
session.created_atstring (data e hora)
session.expires_atstring (data e hora)
userobjeto ou null
user.idstring (uuid)
user.emailstring ou null
scopeslista de stringUm de: read_products, write_products, read_content, write_content, read_orders, write_orders, refund_orders, read_themes, write_themes, publish_themes, read_customers, read_reports.
shop_idstring (uuid)
rate_limitobjeto
rate_limit.bucket_sizeinteger
rate_limit.refill_per_secondnumber
rate_limit.expires_atstring (data e hora) ou null

Erros

  • 401 O token falta, não existe, foi revogado ou venceu (authentication_error).
  • 403 O token não tem o escopo da rota, ou, com write_content, mandou campos que pedem write_products, listados em fields (permission_error).
  • 429 Chamadas demais: espere o Retry-After (rate_limited).
  • 500 Erro do nosso lado (api_error).
  • 503 A API está ocupada com outras chamadas: espere o Retry-After (api_error).

GET /shop

A loja do token

Escopo Qualquer token da loja

O nome, os endereços, a moeda e o fuso da loja. Os valores em dinheiro da API são inteiros em centavos da moeda da loja.

Resposta

200 Sucesso. (Shop)

Os campos da resposta (9)
CampoTipoDescrição
idstring (uuid)
namestring
subdomainstring
storefront_urlstring (URL)
domainstring ou null
currency"BRL"
timezone"America/Sao_Paulo"
locale"pt-BR"
created_atstring (data e hora)

Erros

  • 401 O token falta, não existe, foi revogado ou venceu (authentication_error).
  • 403 O token não tem o escopo da rota, ou, com write_content, mandou campos que pedem write_products, listados em fields (permission_error).
  • 429 Chamadas demais: espere o Retry-After (rate_limited).
  • 500 Erro do nosso lado (api_error).
  • 503 A API está ocupada com outras chamadas: espere o Retry-After (api_error).