Ir para o conteúdo

Comece por aqui · v1 em prévia

Sua primeira consulta, passo a passo.

Prepare um ambiente autorizado e uma credencial com o escopo adequado.

Configure o ambiente local

  1. Defina AKRUS_BASE_URL

    Use a origem do ambiente confirmada pela equipe, sem acrescentar /api/v1.

  2. Guarde AKRUS_API_KEY

    Mantenha a credencial em um gerenciador de segredos ou no ambiente do processo.

  3. Execute no servidor

    Rode a consulta do servidor ou do terminal; nunca inclua a chave no código do navegador.

Faça uma leitura

O exemplo consulta dados e não cria cobranças. Uma lista vazia é uma resposta válida.

curl
curl --fail-with-body --get \
  "${AKRUS_BASE_URL}/api/v1/products" \
  --header "Authorization: Bearer ${AKRUS_API_KEY}" \
  --data-urlencode "limit=10"

Trate o envelope

Quando next_cursor tiver um valor, envie-o na próxima consulta como cursor. Quando for null, a coleção terminou. Confira o status HTTP antes de interpretar data.

Envelope
{
  "data": [],
  "next_cursor": null,
  "version": "v1"
}

Confira o resultado antes de ampliar

Leia o status

  • 200 com data vazia é sucesso; não crie registros reais só para preencher a resposta.
  • 401 exige revisar a credencial; 403 exige revisar plano efetivo e escopo.
  • 429 exige respeitar Retry-After; 503 exige uma política limitada de novas tentativas.

Proteja a credencial

  • Nunca registre Authorization em capturas, histórico de suporte ou logs compartilhados.

Dúvidas frequentes

Referência conferida em 8 de outubro de 2026. Relatar uma dúvida na documentação.