Aesesdocs

Collection do Postman

A collection oficial da Aeses para Postman traz todos os endpoints da API pública pré-organizados em pastas, com autenticação, baseUrl e chaves de idempotência já configurados. Importe uma vez e comece a chamar a API sem montar nenhuma requisição manualmente.

Download

Dois arquivos: a própria collection (requests agrupados por recurso) e um environment com as variáveis que ela usa.

Baixar collection

Baixar environment

O que vem dentro

  • Pastas por recurso — Deposits, Withdrawals, Balances, Assets, Webhook Deliveries.
  • Autenticação no nível da collection — toda requisição herda x-api-key: {{apiKey}} automaticamente.
  • Variável baseUrl — alterne entre sandbox e produção sem mexer em request nenhum.
  • Idempotency-Key preenchido com {{$guid}} — o Postman gera um UUID novo a cada envio, então retries são seguros de saída.
  • Bodies e query strings de exemplo — todo POST e endpoint de listagem já vem com um exemplo realista pronto pra editar e rodar.

Importando no Postman

  1. Abra o Postman e clique em Import (canto superior esquerdo).
  2. Arraste os dois arquivos baixados, ou use Files → Upload.
  3. No seletor de environment (canto superior direito), selecione Aeses — Production.
  4. Clique no ícone de olho e ajuste apiKey com sua chave secreta (sk_live_… ou sk_test_…).
  5. Abra qualquer request — por exemplo, Balances → List balances — e clique em Send.
Use chaves de teste enquanto explora

O environment padrão se chama Production, mas pode ser usado com uma chave sk_test_… — a Aeses roteia a requisição pelo prefixo da chave. Só troque para sk_live_… quando estiver pronto pra movimentar valores reais.

Variáveis

| Variável | Padrão | Onde configurar | | ----------- | ------------------------ | --------------------------- | | baseUrl | https://api.aeses.io | Environment — altere para apontar pra sandbox se necessário. | | apiKey | sk_live_replace_me | Environment — cole sua chave secreta. Armazenada como variável do tipo secret. | | {{$guid}} | gerado automaticamente | Variável dinâmica do Postman — usada no Idempotency-Key. Nada a configurar. |

Mantendo atualizado

A collection é regerada a partir do mesmo descritor usado para validar a API pública. A cada build do site da documentação, os arquivos servidos em /aeses.postman_collection.json e /aeses.postman_environment.json são atualizados — basta reimportar para pegar novos endpoints.