logo
CollectionsPostman Collection
Collections

Collections

Baixe a Postman Collection e o Environment da API Conta Simples para testar os endpoints rapidamente.

Postman Collection & Environment

Use a collection pronta para testar a API Conta Simples diretamente no Postman, Insomnia ou Bruno — sem precisar configurar cada request manualmente.

A collection foi gerada a partir do OpenAPI 3.0.3 oficial da API e contém apenas os endpoints documentados.


Downloads


Como importar e usar

Importe a Collection no Postman

  1. Abra o Postman e clique em Import (canto superior esquerdo).
  2. Arraste o arquivo postman_collection.json ou clique em Upload Files e selecione-o.
  3. A collection API Conta Simples aparecerá na barra lateral com 3 pastas: Autenticação, Cartões & Transações e Anexos.

Importe o Environment

  1. No Postman, clique no ícone de engrenagem (canto superior direito) e selecione Import.
  2. Selecione o arquivo postman_environment_sandbox.json.
  3. O environment Conta Simples — Sandbox ficará disponível no seletor de environments.

Selecione o Environment

No canto superior direito do Postman, abra o seletor de environments e escolha Conta Simples — Sandbox.

Isso garante que todas as variáveis (baseUrl, clientId, clientSecret, token) sejam aplicadas automaticamente nos requests.

Preencha suas credenciais

  1. Clique no environment Conta Simples — Sandbox para editá-lo.
  2. Preencha os valores de:
    • clientId — sua API Key
    • clientSecret — seu API Secret
  3. Salve o environment.

As credenciais são obtidas no Internet Banking da Conta Simples. Consulte o guia de Autenticação para mais detalhes.

Gere o token de acesso

  1. Na collection, abra a pasta Autenticação e clique em Obter Token de Acesso.
  2. Clique em Send.
  3. Se as credenciais estiverem corretas, o token será salvo automaticamente na variável {{token}} (via script de test da collection).
  4. Agora todos os outros requests usarão esse token no header Authorization: Bearer {{token}}.

O token expira em 1 hora. Execute este request novamente quando o token expirar.

Teste os endpoints

Com o token ativo, abra qualquer request da collection e clique em Send:

  • Extrato de Cartão — ajuste startDate, endDate e limit no body.
  • Download de Anexo — preencha o attachmentId obtido na resposta do extrato.

Compatibilidade

A collection usa o formato Postman Collection v2.1, que é compatível com:

FerramentaImportação
PostmanNativa — importe diretamente via Import
InsomniaSuporta importação de Postman Collection v2.x via Import/Export
BrunoSuporta importação de Postman Collection via menu Collection → Import
Thunder Client (VS Code)Suporta importação de Postman Collection v2.1

Conteúdo da collection

A collection contém 3 endpoints organizados em pastas:

PastaEndpointMétodo
Autenticação/oauth/v1/access-tokenPOST
Cartões & Transações/statements/v1/credit-cardPOST
Anexos/attachments/v1/content/{attachmentId}GET

Variáveis utilizadas

VariávelDescriçãoValor padrão (Sandbox)
{{baseUrl}}URL base da APIhttps://api-sandbox.contasimples.com
{{clientId}}API Key(vazio — preencha com sua credencial)
{{clientSecret}}API Secret(vazio — preencha com sua credencial)
{{token}}Token JWT(preenchido automaticamente pelo script)

Para mais detalhes sobre os endpoints, consulte a API Reference.