Guias de Uso

Padrões e tutoriais para integração com a API.

Paginação

Endpoints que retornam coleções suportam paginação através de query parameters:

GET /guarantees?page=1&limit=20

Parâmetros disponíveis:

• page — Número da página (padrão: 1)
• limit — Itens por página (padrão: 20, máximo: 100)

Tratamento de Erros

Respostas de erro seguem um formato padrão:

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Request body is invalid",
    "details": {
      "field": "amount",
      "reason": "must be positive"
    }
  }
}

Webhooks

Configure webhooks para receber notificações em tempo real.

Eventos Disponíveis

• guarantee.created — Nova garantia registrada
• guarantee.liquidated — Garantia foi liquidada
• account.verified — Conta passou em verificação KYC
• wallet.confirmed — Carteira foi confirmada

Payload de Webhook

{
  "id": "evt_123456",
  "event": "guarantee.created",
  "timestamp": "2024-05-12T15:30:00Z",
  "data": {
    "guaranteeId": "gtee_abc123",
    "amount": "100000",
    "currency": "USDT"
  }
}

Rate Limiting

A API implementa rate limiting baseado em token de autenticação:

• Limite padrão: 1.000 requisições por hora
• Janela deslizante: Resetada a cada hora UTC
• Headers de resposta: X-RateLimit-Limit, X-RateLimit-Remaining

Versionamento da API

Versione suas integrações usando o header Accept:

Accept: application/vnd.fortbix.v2+json