Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.atriby.com/llms.txt

Use this file to discover all available pages before exploring further.

Este guia mostra o menor caminho para validar a Atriby em uma integração real.

​
1. Crie sua conta

Acesse https://app.atriby.com/signup, informe email e senha e conclua o cadastro. Depois entre pelo login e abra o dashboard.

​
2. Crie um token

No app, acesse /integracoes?tab=tokens, clique em Novo token e copie o valor gerado. O plaintext aparece somente uma vez. Guarde o token no backend, por exemplo: 
ATRIBY_API_TOKEN="atb_live_..."

​
3. Instale o script de UTMs

Adicione o snippet no <head> da página de oferta, landing page ou página que leva ao checkout: 
<script src="https://app.atriby.com/scripts/utms/latest.js" async defer></script>
O script captura UTMs e click IDs, salva a atribuição no navegador e propaga os parâmetros para links, forms e iframes.

​
4. Envie o primeiro pedido

Quando o checkout gerar um pedido, seu backend deve chamar a Orders API: 
curl -X POST "https://app.atriby.com/api/v1/orders" \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order_001_create" \
  -d '{
    "externalId": "order_001",
    "platform": "checkout",
    "paymentMethod": "credit_card",
    "status": "pending",
    "createdAt": "2026-05-10T15:34:14Z",
    "isTest": true,
    "amounts": {
      "currency": "BRL",
      "grossCents": 20000,
      "netToSellerCents": 17000
    },
    "products": [
      {
        "externalId": "prod_001",
        "sku": "SKU-001",
        "name": "Produto exemplo",
        "quantity": 1,
        "unitPriceCents": 20000
      }
    ],
    "tracking": {
      "utmSource": "facebook",
      "utmMedium": "cpc",
      "utmCampaign": "lancamento"
    }
  }'

​
5. Atualize o status

Quando o pagamento for confirmado: 
curl -X PATCH "https://app.atriby.com/api/v1/orders/order_001" \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order_001_paid" \
  -d '{
    "status": "paid",
    "paidAt": "2026-05-10T15:40:00Z"
  }'

​
6. Valide no dashboard

Abra /pedidos para ver o pedido. Se você enviou isTest: true, ative o toggle Incluir testes nas telas operacionais para enxergar esse pedido no dashboard. Depois valide:
  • /pedidos/[externalId] para detalhe, produtos, taxas e linha do tempo.
  • / para resumo operacional.
  • /campanhas para agregação por utm_source + utm_campaign.
Para entender quais áreas do dashboard são funcionais, parciais ou preview, consulte Status e limites.