O que é o x-api-key da requisição?

O que é a chave de API da Easyflow, onde gerar e como usar nas requisições.

SE

Escrito por Suporte Easyflow

atualizado

Escolha a seção

1. As credenciais da API

Toda requisição à API Easyflow é autenticada por cabeçalhos (headers). Os três obrigatórios são:

  • x-api-key: A API Key: identifica a sua chave.

  • x-api-secret: A Secret: funciona como a senha da chave.

  • business-id: O Business ID: identifica o seu negócio.

# Exemplo de cabeçalhos
x-api-key:
 sua-api-key
x-api-secret:
 sua-api-secret
business-id:
 seu-business-id

2. Onde encontrar cada uma

No menu lateral, no grupo Mais (no fim do menu), clique em Integrações e abra o card API:

Menu lateral → Mais → Integrações · Página API, com o Business ID e o botão Criar (dados ilustrativos)

  • API Key: Aparece na lista de chaves, junto da expiração e do status.

  • Business ID: Fica no topo da página, com o botão de copiar.

  • Secret: É exibida uma única vez, no momento em que a chave é criada.

3. Como criar uma chave

Clique em Criar. Em Geral, preencha o Nome da integração, a Descrição e a Expiração. As opções de expiração são 30 dias, 60 dias, 90 dias, 6 meses, 1 ano ou uma data específica.

Formulário Criar chave de API

Em Permissões, marque só os recursos que a integração vai usar, como Pedidos, Produtos, Vendas, Financeiro, Reembolso, Clientes, Assinatura, Link de Pagamento, Pixel, Webhook, Vouchers, Participantes, Eventos e Planos.

Lista de permissões

Passo a passo

  1. Revise os dados e as permissões

  2. Clique em Criar chave

  3. Copie a Secret na hora e guarde em local seguro

4. Perdi a minha Secret

Atenção: Por segurança, não é possível visualizar nem recuperar uma Secret depois que a tela de criação é fechada. O único caminho é criar uma nova chave.

Para resolver:

  • 1. Crie uma nova chave: Siga a etapa 03 desta página.

  • 2. Guarde a nova Secret: Em um local seguro, como um gerenciador de senhas.

  • 3. Substitua a chave antiga: Atualize os dados no sistema que usa a integração.

5. Boas práticas

  • Permissões mínimas: Libere só os recursos que a integração precisa.

  • Fique de olho na expiração: A data aparece na lista de chaves.

  • Nunca exponha a Secret: Não a coloque em sites, apps ou repositórios públicos.

  • Uma chave por integração: Facilita trocar ou desativar uma sem afetar as outras.

VEJA TAMBÉM

Documentação da API: docs.easyflow.digital

Como integrar com a Memberkit