Documentacao da API Publica

Modelo no padrao da Cilia, adaptado para a API da Up Integration.

OpenAPI / Swagger

Use estes arquivos para publicar, versionar e testar a integracao.

Abrir Swagger UI interativa Abrir OpenAPI JSON Abrir OpenAPI YAML

Ambientes

Ambiente Base URL Observacao
Producao https://integration.upyouridea.com.br Ambiente oficial para parceiros.

Autenticacao

Todos os endpoints publicos exigem token Bearer.

Authorization: Bearer SEU_TOKEN

1) API de Estoque - Listar Itens

GET /api/v1/stock

Consulta paginada de estoque por cliente/token.

Parametros de Requisicao

Parametro Tipo Obrigatorio Descricao
skustringNaoFiltro exato por SKU.
eanstringNaoFiltro exato por EAN.
updated_sincedatetimeNaoRetorna itens atualizados a partir de uma data/hora.
pageintegerNaoPagina atual (default 1).
per_pageintegerNaoItens por pagina (max 200).

Exemplo de Requisicao

curl --location 'https://integration.upyouridea.com.br/api/v1/stock?per_page=100' \
  --header 'Authorization: Bearer SEU_TOKEN' \
  --header 'Accept: application/json'

Exemplo de Resposta 200

{
  "data": [
    {
      "source_product_id": 35154,
      "sku": "18253",
      "ean": "7909501027840",
      "name": "ALMA PARACHOQUE DIANTEIRA CLIO RENAULT 2006/2011",
      "brand": "Renault",
      "price": 151.84,
      "quantity": 127,
      "status": "publish",
      "product_updated_at": "2026-05-13T11:55:23+00:00",
      "snapshot_updated_at": "2026-05-15T20:17:22+00:00"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 100,
    "total": 24963,
    "last_page": 250
  }
}

2) API de Estoque - Buscar por SKU

GET /api/v1/stock/{sku}

Busca item unico por SKU dentro do cliente associado ao token.

Exemplo de Requisicao

curl --location 'https://integration.upyouridea.com.br/api/v1/stock/18253' \
  --header 'Authorization: Bearer SEU_TOKEN' \
  --header 'Accept: application/json'

Status HTTP

Status Motivo Retorno
200Item encontradoObjeto data com SKU solicitado.
401Token ausente/invalidado{"message":"Token ausente. Use Authorization: Bearer <token>."}
404SKU nao encontrado{"message":"SKU nao encontrado."}
429Limite excedidoRate limit por token.

3) API de Eventos e Pedidos (Fluxo Operacional)

Fluxo de referencia da operacao entre fonte de dados, Up Integration e Cilia.

Entrada no Integration

MetodoEndpointDescricao
POST/api/webhooks/cilia/ordersRecebe eventos/pedidos da Cilia.
POST/api/webhooks/inboundWebhook generico para outras plataformas.

Saida para Cilia (referencia)

MetodoEndpointUso
POST.../supply_pieces/batchEnvio de estoque em JSON.
POST.../supply_pieces/batch/fileEnvio de estoque por arquivo.
GET/PUT/POST.../suppliers/orders/*Consulta pedido, atualiza status, finaliza evento, envia NF.

Fluxograma Operacional

Modelo visual do fluxo da operacao (imagem estatica).

Fluxograma operacional da API publica

Observacoes Importantes

TemaDefinicao
Banco do clienteSomente leitura no processo de sincronizacao.
Banco da UpArmazena snapshot e metadados de API/token.
IsolamentoDados separados por tenant_id; token consulta apenas o cliente vinculado.
EscalabilidadeConsulta publica responde do snapshot local (mais rapido e estavel).