> ## Documentation Index
> Fetch the complete documentation index at: https://docs.solomon.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Início Rápido

> Envie seus primeiros dados para a Solomon em poucos minutos

## Comece em quatro passos

Configure sua integração com a Solomon e envie seus primeiros pedidos, produtos e eventos.

### Passo 1: Configure o acesso à API

<AccordionGroup>
  <Accordion icon="key" title="Obtenha uma API key durante o onboarding">
    Durante o onboarding, na seção de integração de plataforma de vendas, selecione a opção "API" e clique para gerar os dois tokens
    de integração, que serão exibidos na tela.
  </Accordion>

  <Accordion icon="key" title="Obtenha uma API key após o onboarding">
    Para se autenticar na Solomon API, você precisa de uma API Key válida. Para isso:

    1. Acesse a aba de Chaves de API no canto superior direito (clicando no nome da sua loja).
    2. Crie uma nova chave com um nome de identificação, do tipo "Plataforma Própria"
    3. Marque os escopos `write_orders` e `write_products`\
       Nesse caso, você pode gerar uma API Key tanto para ambiente live quanto para sandbox.
  </Accordion>
</AccordionGroup>

<Tip>Guarde suas chaves em um local seguro. Elas serão usadas para autenticar todas as requisições feitas.</Tip>

### Passo 2: Envie seu primeiro pedido

<AccordionGroup>
  <Accordion icon="receipt" title="Criar um pedido via API">
    Faça uma requisição `POST` para o endpoint de pedidos:

    ```bash theme={null}
    curl -X POST https://admin-api.solomon.com.br/admin/v1/order \
      -H "Authorization: Bearer YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "orderId": "ord_123456789",
        "number": 10234,
        "name": "Pedido #10234",
        "orderStatus": 0,
        "createdAt": "2026-01-10T14:32:10Z",
        "updatedAt": "2026-01-10T14:35:42Z",
        "totalPrice": 249.90,
        "totalDiscounts": 20,
        "shippingPrice": 19.90,
        "paymentMethod": 2,
        "installments": 3,
        "currency": "BRL",
        "discountCode": "WELCOME10",
        "provinceCode": "SP",
        "countryCode": "BR",
        "utmSource": "facebook",
        "utmMedium": "cpc",
        "utmCampaign": "promo_janeiro",
        "utmContent": "video_1",
        "utmTerm": "tenis masculino",
        "userId": "d81a69cf-82d5-4aad-9ecd-5945b3cf3528",
        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)",
        "browserIp": "189.45.123.10",
        "cartToken": "cart_abcd1234",
        "customer": {
          "customerId": "cus_987654321",
          "name": "Cliente Teste",
          "email": "cliente_teste@email.com",
          "phone": "+5511999999999",
          "provinceCode": "SP",
          "countryCode": "BR",
          "zip": "12230-000",
          "city": "São José dos Campos",
          "createdAt": "2025-11-02T10:15:00Z",
          "updatedAt": "2026-01-10T14:30:00Z"
        },
        "items": [
          {
            "itemId": "item_1",
            "productId": "prod_123",
            "variantId": "var_azul_42",
            "quantity": 1,
            "price": 199.90,
            "discount": 20.00,
            "createdAt": "2026-01-10T14:32:10Z",
            "updatedAt": "2026-01-10T14:32:10Z"
          }]
      }'
    ```

    Se a requisição for bem-sucedida, o pedido será registrado na Solomon.
  </Accordion>
</AccordionGroup>

### Passo 3: Envie seus produtos

<AccordionGroup>
  <Accordion icon="box" title="Enviar um produto via API">
    Faça uma requisição `POST` para o endpoint de produtos:

    ```bash theme={null}
    curl -X POST https://admin-api.solomon.com.br/admin/v1/product \
      -H "Authorization: Bearer YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "productId": "prod_123",
        "productName": "Tênis Esportivo Verde",
        "createdAt": "2026-01-10T14:00:00Z",
        "updatedAt": "2026-01-10T14:00:00Z",
        "status": 1,
        "variants": [{
          "variantId": "var_azul_42",
          "title": "Tênis Esportivo Verde - Azul 42",
          "sku": "TEN-VER-AZU-42",
          "price": 199.90,
          "currency": "BRL",
          "createdAt": "2026-01-10T14:00:00Z",
          "updatedAt": "2026-01-10T14:00:00Z"
        }]
      }'
    ```

    Se a requisição for bem-sucedida, o produto será registrado na Solomon.
  </Accordion>
</AccordionGroup>

<Warning>
  O envio de produtos é essencial para que dados de funil de produto e estatísticas apareçam na plataforma.
  Envie o catálogo completo logo no início da integração e mantenha-o atualizado conforme produtos forem criados ou alterados.
</Warning>

### Passo 4: Envie um evento com o SDK

<AccordionGroup>
  <Accordion icon="bolt" title="Instale e inicialize o SDK">
    Instale o SDK da Solomon:

    ```bash theme={null}
    npm install @solomon/events
    ```

    Inicialize o SDK no seu frontend ou backend:

    ```ts theme={null}
    import { SolomonSDK } from "@solomon/events";

    const solomon = new SolomonSDK({
      companyId: "SEU_COMPANY_ID",
    });
    ```

    Envie um evento de purchase:

    ```ts theme={null}
    solomon.track("CHECKOUT_COMPLETED", {
      items: [{
        item_id: "item_1",
        item_quantity: 1
      }]
    }, {
      email: "cliente_teste@email.com",
      phone: "+5511999999999",
      customer_id: "cus_987654321",
      cart_token: "cart_abcd1234"
    });
    ```

    <Tip>
      A Solomon utiliza esses eventos para fazer a atribuição correta de cada pedido.
    </Tip>
  </Accordion>
</AccordionGroup>

## Próximos passos

Agora que você conseguiu enviar seu primeiro pedido, explore outras funcionalidades essenciais:

<CardGroup cols={2}>
  <Card title="Enviar e atualizar pedidos" icon="receipt" href="/store/orders">
    Aprenda como enviar pedidos completos, lidar com atualizações de status e evitar duplicações.
  </Card>

  <Card title="Enviar e atualizar produtos" icon="box" href="/store/products">
    Envie e mantenha o catálogo de produtos sincronizado com a Solomon.
  </Card>

  <Card title="Enviar eventos do site" icon="wave-pulse" href="/events/development">
    Utilize o SDK para rastrear os demais eventos do site, como page view, add to cart e initiate checkout.
  </Card>

  <Card title="Explorar a Referência da API" icon="code" href="/events/concepts">
    Entenda como desenvolver soluções de forma técnica com a Solomon.
  </Card>
</CardGroup>

<Note>
  **Need help?** See our [full documentation](https://mintlify.com/docs) or join our [community](https://mintlify.com/community).
</Note>