Checkout: como gerar uma Chave de API

Aprenda a criar sua chave de API e utilizar o ID da organização nas requisições.

Como criar uma nova chave

1 - Siga o caminho abaixo dentro do painel: - Checkout → Ferramentas → Chaves de API

2 - Depois, clique em Nova chave de API e preencha as informações.

Campos disponíveis:

Campo	Descrição
Nome	Identifique a finalidade da chave (ex.: Integração CRM).
Expiração	Defina uma data ou marque Nunca expira.
Permissões	Selecione apenas os recursos que sua integração utilizará.

Importante: após clicar em Criar nova Chave de API, copie e guarde a chave imediatamente. Ela não poderá ser visualizada novamente.

Autenticação das requisições

Toda chamada autenticada deve enviar sua chave no header Authorization:

Authorization: SUA_API_KEY

Além disso, a maioria dos endpoints também exige o header X-Organization-Id, responsável por definir em qual organização a operação será executada.

O que é o X-Organization-Id?

Esse header informa à API qual organização deve ser utilizada durante a requisição.

Mesmo que atualmente você possua apenas uma organização, a API já suporta múltiplas organizações por usuário. Por isso, o identificador é enviado separadamente da autenticação.

Exemplo do header:

X-Organization-Id: 7484034641094152192

Como descobrir o ID da organização

Antes de realizar outras operações, consulte o endpoint de organizações:

curl --request GET \
  --url https://api.thebank.com/core/v1/organizations \
  --header 'Authorization: SUA_API_KEY' \
  --header 'Accept: application/json'

A resposta retornará as organizações vinculadas ao usuário. Utilize o campo id da organização desejada nas próximas requisições.

X-Organization-Id: ID_DA_ORGANIZACAO

Exemplo de requisição completa

curl --request GET \
  --url https://api.thebank.com/core/v1/products \
  --header 'Authorization: SUA_API_KEY' \
  --header 'Accept: application/json' \
  --header 'X-Organization-Id: 7484034641094152192'

Fluxo recomendado:

Gere uma Chave de API no painel.
Armazene a chave em um ambiente seguro.
Consulte GET /organizations para obter o ID da organização.
Envie Authorization e X-Organization-Id em todas as chamadas autenticadas.

Atualizado em: 20/09/2026