Chaves de API

Abrindo uma conta na Elix

Para utilizar os recursos privados da API da Elix, é necessário possuir uma conta bancária PJ aprovada.

A abertura pode ser iniciada pelo cadastro da Elix. Se a empresa estiver em conformidade com os requisitos cadastrais, a análise costuma ser concluída em até 72 horas.

Após a aprovação, sua empresa poderá:

• Gerar e gerenciar chaves de API.
• Utilizar os recursos liberados para a conta.
• Acessar a Elix pelo Painel e pelos aplicativos Android e iOS.
• Receber em uma única conta o saldo das vendas realizadas pela API.
• Criar cobranças pelo Painel, pela API ou pelo aplicativo.
• Utilizar produtos como Links de Pagamento, Pix, boleto, boleto parcelado e cartão de crédito, conforme disponibilidade.

O que você pode fazer no Painel

As chaves são gerenciadas diretamente na Área do Cliente da Elix. No Painel, você pode:

• Consultar a credencial ativa da sua conta.
• Gerar um novo par de API Key e Secret Key.
• Revogar imediatamente uma credencial comprometida.
• Consultar o histórico recente de chamadas autenticadas.
• Cadastrar rotas de webhook para os eventos liberados para sua conta.

Como obter sua primeira chave

Este passo a passo considera que sua conta PJ já está aprovada e que você consegue acessar a Área do Cliente.

1. 1

   Acesse sua conta

   Entre na Área do Cliente com o usuário responsável pela integração.

   

2. 2

   Abra Minha conta

   Abra o menu do usuário no canto superior direito e selecione Minha conta. Na tela do perfil, acesse a aba Credenciais API.

   

3. 3

   Gere as credenciais

   Clique em Gerar credenciais, leia os termos de uso e confirme a operação. A conta começa sem nenhuma chave ativa.

   

4. 4

   Guarde a Secret Key

   Copie a API Key e a Secret Key para um gerenciador seguro. A Secret Key completa é exibida somente no momento da criação.
5. 5

   Valide a integração

   Faça uma chamada de leitura no seu backend e confirme o retorno antes de iniciar a implementação de cobranças.

Uma credencial ativa por vez

Se já existir uma credencial ativa, será necessário revogá-la antes de gerar um novo par. A revogação interrompe imediatamente as integrações que utilizam a chave anterior.

Práticas de segurança

• Nunca exponha credenciais em repositórios públicos, aplicativos ou código executado no navegador.
• Armazene API Key e Secret Key em variáveis de ambiente no servidor.
• Use credenciais dedicadas por serviço e mantenha o menor escopo necessário.
• Revogue imediatamente qualquer chave comprometida.
• Não registre o header Authorization em logs de aplicação.

Testando a chave obtida

Execute o teste somente no backend. Substitua SEU_TOKEN_BASE64 pelo resultado de base64(api_key:secret_key).

import http.client
conn = http.client.HTTPSConnection("api.elixbank.com.br")payload = ""headers = {  "accept": "application/json",  "Authorization": "Basic SEU_TOKEN_BASE64"}
conn.request("GET", "/api/v1/balance/available", payload, headers)res = conn.getresponse()data = res.read()
print(data.decode("utf-8"))

import http.client
conn = http.client.HTTPSConnection("api.elixbank.com.br")payload = ""headers = {  "accept": "application/json",  "Authorization": "Basic SEU_TOKEN_BASE64"}
conn.request("GET", "/api/v1/balance/available", payload, headers)res = conn.getresponse()data = res.read()
print(data.decode("utf-8"))