Introdução
Comece a usar a YaVendio Business API em minutos
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 → 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
curl -X GET "https://api.ya.onl/v1/orders?page=1&limit=5" \
-H "X-API-Key: yv_live_v1_sua_api_key"3. Explorar a Resposta
{
"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
Autenticação
Aprenda como as API keys funcionam, escopos e boas práticas.
Paginação
Navegue por grandes conjuntos de resultados de forma eficiente.
Rate Limiting
Entenda os limites de requisições e como lidar com eles.
Tratamento de Erros
Trate erros corretamente na sua integração.
Gerenciar Produtos
Aprenda a criar e gerenciar produtos com variantes, opções, mídia e categorias.
Mensagens de Template
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.
