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

# Introdução

> Comece a usar a YaVendio Business API em minutos

# YaVendio Business API

A Business API permite que os merchants da YaVendio leiam programaticamente seus **pedidos**, **conversas**, **contatos** e o **perfil da empresa**, gerenciem seu **catálogo de produtos** e **enviem mensagens de template pelo WhatsApp** (assim que a conta estiver habilitada para envio). Use-a para construir integrações, sincronizar dados com sistemas externos ou alimentar dashboards personalizados.

## Início Rápido

Obtenha sua primeira resposta da API em três passos:

### 1. Criar uma API Key

Vá ao [Dashboard da YaVendio](https://ya.onl) → **Configurações** → **Chaves API** e clique em **"Criar API Key"**. Atribua um nome descritivo; a key é criada com acesso completo à API.

### 2. Fazer sua Primeira Requisição

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://api.ya.onl/v1/orders?page=1&limit=5" \
    -H "X-API-Key: yv_live_v1_sua_api_key"
  ```

  ```python Python theme={null}
  import httpx

  response = httpx.get(
      "https://api.ya.onl/v1/orders",
      params={"page": 1, "limit": 5},
      headers={"X-API-Key": "yv_live_v1_sua_api_key"},
  )
  print(response.json())
  ```

  ```javascript Node.js theme={null}
  const response = await fetch(
    "https://api.ya.onl/v1/orders?page=1&limit=5",
    {
      headers: { "X-API-Key": "yv_live_v1_sua_api_key" },
    }
  );
  const data = await response.json();
  console.log(data);
  ```
</CodeGroup>

### 3. Explorar a Resposta

```json theme={null}
{
  "data": [
    {
      "id": 12345,
      "order_date": "2026-03-10T15:30:00Z",
      "status": "confirmed",
      "currency": "BRL",
      "total_amount": 139.70
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 5,
    "total_pages": 10,
    "total_items": 48,
    "has_more": true
  }
}
```

## Próximos Passos

<CardGroup cols={2}>
  <Card title="Autenticação" icon="key" href="/pt/authentication">
    Aprenda como as API keys funcionam, escopos e boas práticas.
  </Card>

  <Card title="Paginação" icon="arrow-right" href="/pt/pagination">
    Navegue por grandes conjuntos de resultados de forma eficiente.
  </Card>

  <Card title="Rate Limiting" icon="gauge" href="/pt/rate-limiting">
    Entenda os limites de requisições e como lidar com eles.
  </Card>

  <Card title="Tratamento de Erros" icon="triangle-exclamation" href="/pt/errors">
    Trate erros corretamente na sua integração.
  </Card>

  <Card title="Gerenciar Produtos" icon="box" href="/pt/products/data-model">
    Aprenda a criar e gerenciar produtos com variantes, opções, mídia e categorias.
  </Card>

  <Card title="Mensagens de Template" icon="paper-plane" href="/pt/outbound/cart-abandonment">
    Escreva primeiro para um cliente com um template aprovado — recuperar um carrinho,
    avisar que um pedido está pronto — e consulte em que estado ele ficou.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.