intake

Autenticação

Como autenticar suas requisições na nossa API.

Nossa API utiliza chaves de autenticação via Header Authorization. Existem dois tipos principais de chaves, cada uma com escopos de permissão diferentes e casos de uso específicos.

Tipos de Chave

Chave de Pública

A Chave Pública permite realizar operações relacionadas a transações e pagamentos:

  • ✅ Criar e consultar pedidos (PIX, Cartão, Boleto)
  • ✅ Tokenizar cartões de crédito
  • ✅ Consultar status de transações
  • ✅ Listar pedidos com filtros

A chave de pública deve ser usada somente no client-side (aplicações web, mobile), pois permite apenas criar e consultar pedidos. Ele não permite realizar saques ou acessar informações sensíveis.

Formato de uso:

Authorization: Bearer SUA_CHAVE_PUBLICA

Chave Secreta

A Chave Secreta é uma chave com permissões sensíveis, utilizada exclusivamente para operações financeiras críticas:

  • ✅ Consultar saldo disponível e pendente
  • ✅ Realizar saques para chaves PIX
  • ✅ Consultar histórico de saques

NUNCA compartilhe sua Chave Secreta em ambientes client-side. Esta chave deve ser mantida exclusivamente no backend e nunca exposta em código JavaScript, aplicações mobile ou qualquer ambiente acessível ao cliente.

Formato de uso:

Authorization: Bearer SUA_CHAVE_SECRETA

Comparação das Chaves

FuncionalidadeChave PúblicaChave Secreta
Criar pedidos
Consultar pedidos
Tokenizar cartão
Consultar saldo
Realizar saque
Uso no client-side
Uso no backend

Como Obter as Chaves

Autenticação de Webhook

Configure um token de autenticação na plataforma que será enviado no header Authorization de todas as requisições de webhook:

Authorization: Bearer SEU_TOKEN_WEBHOOK

Recomendamos sempre validar a origem dos webhooks para garantir a segurança da sua integração. Nunca processe webhooks sem validação adequada.

Exemplos de Uso

Criar um Pedido (Chave Pública)

curl -X POST https://api.intake.finance/v1/orders \
  -H "Authorization: Bearer SUA_CHAVE_PUBLICA" \
  -H "Content-Type: application/json" \
  -d '{
    "external_id": "pedido-12345",
    "amount": 10000,
    "payment_method": "PIX"
  }'

Consultar Saldo (Chave Secreta)

curl -X GET https://api.intake.finance/v1/balances/summary \
  -H "Authorization: Bearer SUA_CHAVE_SECRETA"

Realizar Saque (Chave Secreta)

curl -X POST https://api.intake.finance/v1/withdraws \
  -H "Authorization: Bearer SUA_CHAVE_SECRETA" \
  -H "Content-Type: application/json" \
  -d '{
    "external_id": "saque-12345",
    "amount": 5000,
    "pix_key": "usuario@exemplo.com"
  }'

Boas Práticas de Segurança

  1. Nunca exponha a Chave Secreta em código client-side
  2. Use variáveis de ambiente para armazenar chaves no backend
  3. Valide sempre os webhooks antes de processá-los
  4. Rotacione as chaves periodicamente para maior segurança
  5. Use HTTPS para todas as requisições

Se você suspeitar que alguma chave foi comprometida, revogue-a imediatamente na plataforma e gere uma nova.

On this page