BlendFi

Coleção do Postman

Baixe a coleção Postman para parceiros e os ambientes sandbox e produção para exercitar cada endpoint da BlendFi sem escrever código.

Uma coleção Postman pronta para importar com cada endpoint voltado a parceiros da BlendFi, pareada com arquivos de ambiente que pré-configuram a URL base e um placeholder api_key para a sua API key.

Baixar

  • Coleção partner (JSON): cada endpoint sob os prefixos voltados a parceiros (/v1/users, /v1/kyc, /v1/quotes, /v1/conversions, /v1/test_helpers, /v1/webhook_endpoints, /v1/webhook_deliveries).
  • Ambiente sandbox (JSON): pré-configurado com baseUrl = https://api.sandbox.blendfi.com.br e uma variável api_key em branco.
  • Ambiente produção (JSON): pré-configurado com baseUrl = https://api.blendfi.com.br e uma variável api_key em branco.

Importar no Postman

O caminho mais rápido:

  1. Abra o Postman.
  2. File → Import → Link (ou arraste e solte os arquivos baixados no painel esquerdo do Postman).
  3. Cole uma destas URLs:
    • https://docs.blendfi.com.br/postman/blendfi-partner.postman_collection.json (a coleção)
    • https://docs.blendfi.com.br/postman/blendfi-partner.sandbox.postman_environment.json (ambiente sandbox)
    • https://docs.blendfi.com.br/postman/blendfi-partner.production.postman_environment.json (ambiente produção)
  4. Repita para cada arquivo que quiser importar.
  5. No seletor de ambiente do Postman (canto superior direito), escolha BlendFi Core, Sandbox ou BlendFi Core, Production.

Autenticar

O ambiente vem com a variável api_key em branco. Defina uma vez e cada request da coleção a injeta no header Authorization: Bearer {{api_key}}.

  1. Clique na aba Environments na barra lateral esquerda do Postman.
  2. Abra BlendFi Core, Sandbox (ou Production).
  3. Cole a sua API key (sandbox: sk_test_…, produção: sk_live_…) em api_keyCurrent Value.
  4. Salve.

Pegue uma chave sandbox primeiro

Se você ainda não tem uma chave sandbox, veja Sandbox e chaves para o fluxo de pedido.

Caminhe por um request

Um round-trip para confirmar que tudo está conectado:

  1. Na coleção, encontre Users → Create user.
  2. O body do request tem um JSON placeholder; os únicos campos que você precisa preencher são external_id (qualquer string única), name, document_type (cpf ou cnpj) e document_number. Um CPF sandbox seguro é 52998224725.
  3. Clique em Send.
  4. Espere uma resposta 201 com o id do usuário. Se vier 401 authentication_failed, a variável api_key não está sendo aplicada; confira o seletor de ambiente.

A partir daí, cada outro endpoint da coleção funciona do mesmo jeito: ajuste o body, clique em Send, observe.

Test_helpers para avançar estado sandbox-only

A coleção inclui os sete endpoints test_helpers em Test Helpers / Transactions (e um em Test Helpers / Users). Use-os para avançar o ciclo de vida de uma conversão sem esperar Pix real ou confirmações on-chain.

Mantendo sincronizado

A coleção e os ambientes são commitados no repo da API da BlendFi e atualizados periodicamente. Baixe novamente desta página para pegar o conjunto mais recente de endpoints. A Referência OpenAPI deste site (/docs/reference) é a fonte canônica para contratos de endpoint, em qualquer conflito entre o Postman e a Referência, a Referência vence.

Apenas partner, a coleção interna nunca é publicada

A coleção Postman interna da BlendFi (usada por ops e ferramentas admin) não pode ser exposta na internet aberta. Três camadas de defesa previnem publicação acidental: o script de sync (pnpm postman:sync) hardcoda a lista de arquivos partner-only e recusa qualquer um com internal; uma regra .gitignore bloqueia git add acidental de public/postman/*internal*; um workflow de CI (partner-postman-guard.yml) falha qualquer PR que entregue um artefato interno em public/. Mantenedores que atualizam esta coleção devem rodar pnpm postman:sync em vez de copiar arquivos à mão.

Relacionado

Nesta página