Pular para o conteúdo principal

🚀 Guia de Início Rápido

Bem-vindo à nossa documentação oficial! Este guia irá ajudá-lo a dar os primeiros passos para integrar nossa solução de pagamentos em sua aplicação.

📋 Visão Geral

A API FastSoft White Label oferece uma solução completa para:

  • 💳 Processamento de Pagamentos: PIX, Boleto e Cartão de Crédito
  • 💰 Gestão de Transações: Controle completo sobre suas transações
  • 🔄 Sistema de Webhooks: Notificações em tempo real
  • 💸 Cashout: Transferências e saques automatizados

🔑 Pré-requisitos

Antes de começar, certifique-se de ter:

  1. Credenciais de API

    • Token de autenticação
    • URL base da API
  2. Ambiente de Desenvolvimento

    • Cliente HTTP (Postman, Insomnia, ou biblioteca de sua linguagem)
    • Ambiente para receber webhooks (opcional para testes iniciais)

🎯 Primeiros Passos

1. Autenticação

Todas as requisições à API devem incluir o header de autenticação. O token deve estar no formato x:CHAVE_SECRETA convertido para base64:

Authorization: Basic <token_base64>

Formato do Token:

  • Combine x:CHAVE_SECRETA (onde x é literal e CHAVE_SECRETA é sua chave secreta)
  • Converta para base64
  • Use o resultado no header Authorization

Exemplo:

# Se sua chave secreta for: abc123
# O formato será: x:abc123
# Convertido para base64: eDphYmMxMjM=
# Header final: Authorization: Basic eDphYmMxMjM=

2. Teste de Conexão

Faça uma requisição simples para verificar se suas credenciais estão funcionando:

curl -X GET https://api.abmex.io/api/user/wallet/balance \
-H "Authorization: Basic <seu_token_base64_aqui>"

3. Sua Primeira Transação

Exemplo de criação de uma transação PIX:

POST /api/user/transactions
{
"amount": 500,
"paymentMethod": "PIX",
"customer": {
"name": "João da Silva",
"email": "joao.silva@email.com",
"document": {
"number": "12345678900",
"type": "CPF"
},
"phone": "11987654321",
"externaRef": "cliente-12345"
},
"shipping": {
"fee": 0,
"address": {
"street": "Avenida Paulista",
"streetNumber": "123",
"complement": "Apto 101",
"zipCode": "01000000",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"country": "br"
}
},
"items": [
{
"title": "Produto XYZ",
"unitPrice": 500,
"quantity": 1,
"tangible": true,
"externalRef": "produto-xyz-001"
}
],
"traceable": true,
"ip": "192.168.1.1",
"postbackUrl": "https://meusite.com/webhook/pagamentos",
"metadata": {
"pedido_id":"12345"
},
"pix": {
"expiresInDays": 1
}
}

🛠️ Ambientes

AmbienteURL BaseDescrição
Produçãohttps://api.abmex.ioAmbiente de produção com transações reais

📚 Próximos passos: Autenticação | Criar Primeira Transação | Webhooks