Início Rápido

Visão geral

A API REST Vitry permite que sistemas externos (ERPs, apps, marketplaces) se integrem com sua loja de forma programática. Todas as operações disponíveis no painel admin podem ser feitas via API.

Base URL:

https://sualoja.com.br/api/v1

1. Gerar uma API Key

Acesse o painel admin da sua loja:

1. Navegue até Configurações → Chaves de API
2. Clique em Gerar nova chave
3. Dê um nome (ex: "Integração Bling")
4. Copie a chave imediatamente — ela não será exibida novamente

2. Fazer sua primeira requisição

Use a chave no header X-API-Key ou Authorization: Bearer:

cURL

curl -X GET https://sualoja.com.br/api/v1/products \
  -H "X-API-Key: SUA_CHAVE_AQUI" \
  -H "Accept: application/json"

PHP

$response = Http::withHeaders([
    'X-API-Key' => 'SUA_CHAVE_AQUI',
    'Accept' => 'application/json',
])->get('https://sualoja.com.br/api/v1/products');

$products = $response->json();

JavaScript

const response = await fetch('https://sualoja.com.br/api/v1/products', {
  headers: {
    'X-API-Key': 'SUA_CHAVE_AQUI',
    'Accept': 'application/json',
  },
});

const data = await response.json();

3. Resposta

A API retorna JSON com o envelope data para listas e paginação em meta:

{
  "data": [
    {
      "id": 1,
      "name": "Camiseta Preta",
      "price": 79.90,
      "stock": 150,
      "active": true
    }
  ],
  "links": {
    "first": "...?page=1",
    "last": "...?page=5",
    "prev": null,
    "next": "...?page=2"
  },
  "meta": {
    "current_page": 1,
    "last_page": 5,
    "per_page": 25,
    "total": 120
  }
}

4. Criar um produto

curl -X POST https://sualoja.com.br/api/v1/products \
  -H "X-API-Key: SUA_CHAVE_AQUI" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "Camiseta Azul",
    "type": "simple",
    "price": 89.90,
    "sku": "CAM-AZUL-001",
    "stock": 100,
    "active": true
  }'

Resposta (201 Created):

{
  "data": {
    "id": 2,
    "type": "simple",
    "name": "Camiseta Azul",
    "slug": "camiseta-azul",
    "sku": "CAM-AZUL-001",
    "price": 89.90,
    "stock": 100,
    "active": true
  }
}

Rate Limiting

A API limita a 60 requisições por minuto por chave. Ao ultrapassar, retorna 429 Too Many Requests.

Próximos passos

• Autenticação — detalhes sobre API keys
• Produtos — CRUD completo de produtos
• Webhooks — receba notificações em tempo real