> ## 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.

# Introducción

> Comienza a usar la YaVendio Business API en minutos

# YaVendio Business API

La Business API permite a los merchants de YaVendio leer programáticamente sus **órdenes**, **conversaciones**, **contactos** y el **perfil de su empresa**, gestionar su **catálogo de productos** y **enviar mensajes de plantilla por WhatsApp** (una vez que su cuenta esté habilitada para enviar). Úsala para construir integraciones, sincronizar datos con sistemas externos o alimentar dashboards personalizados.

## Inicio Rápido

Obtén tu primera respuesta de la API en tres pasos:

### 1. Crear una API Key

Ve al [Dashboard de YaVendio](https://ya.onl) → **Configuración** → **Claves API** y haz clic en **"Crear API Key"**. Asigna un nombre descriptivo; la key se crea con acceso completo a la API.

### 2. Hacer tu Primera Petición

<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_tu_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_tu_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_tu_api_key" },
    }
  );
  const data = await response.json();
  console.log(data);
  ```
</CodeGroup>

### 3. Explorar la Respuesta

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

## ¿Qué sigue?

<CardGroup cols={2}>
  <Card title="Autenticación" icon="key" href="/authentication">
    Aprende cómo funcionan las API keys, alcances y buenas prácticas.
  </Card>

  <Card title="Paginación" icon="arrow-right" href="/pagination">
    Navega por grandes conjuntos de resultados de forma eficiente.
  </Card>

  <Card title="Rate Limiting" icon="gauge" href="/rate-limiting">
    Entiende los límites de peticiones y cómo manejarlos.
  </Card>

  <Card title="Manejo de Errores" icon="triangle-exclamation" href="/errors">
    Maneja errores correctamente en tu integración.
  </Card>

  <Card title="Gestionar Productos" icon="box" href="/products/data-model">
    Aprende a crear y gestionar productos con variantes, opciones, media y categorías.
  </Card>

  <Card title="Mensajes de Plantilla" icon="paper-plane" href="/outbound/cart-abandonment">
    Escríbele primero a un cliente con una plantilla aprobada — recuperar un carrito,
    avisar que un pedido está listo — y consulta en qué estado quedó.
  </Card>
</CardGroup>


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