Visão geral dos endpoints

Todos os endpoints usam a URL base: https://your-app-domain.com/api/public

Elegibilidade de garantia

Método	Caminho	Descrição
GET / POST	/warranty-eligibility	Verifica a elegibilidade de garantia de um produto
POST	/warranty/eligibility	Verifica a elegibilidade de um item de linha do pedido
GET / POST	/assess-eligibility	Reavalia em lote a elegibilidade de uma organização (admin)
GET	/assess-eligibility/all	Avalia em lote todas as organizações (admin)

Garantias

Método	Caminho	Descrição
GET	/warranty/{warrantyId}	Obtém os detalhes de uma garantia pelo ID

Apólices

Método	Caminho	Descrição
GET	/policies/fetch	Obtém todas as apólices de um cliente
GET	/policies/fetch/{policyId}	Obtém uma apólice específica pelo ID
POST	/policies/fetch/order-line-item-policy	Encontra a apólice de um item de linha do pedido
POST	/policies/validate	Valida uma apólice pelo ID e pelo nome do pedido

Sinistros

Método	Caminho	Descrição
POST	/claims/submit	Envia um sinistro de garantia vinculado a uma apólice
POST	/claims/submit-manual	Envia um sinistro aberto pelo lojista (sem apólice)
GET	/claims/fetch	Obtém os sinistros de uma apólice e de um cliente
GET	/claims/{id}/evidence	Obtém os arquivos de evidência de um sinistro
POST	/claims/upload-urls	Gera URLs pré-assinadas para envio de evidências
POST	/claims/upload	Envia evidências do sinistro diretamente
POST	/claims/evidence	Anexa os metadados das evidências a um sinistro

Produtos

Método	Caminho	Descrição
GET	/products/search	Pesquisa produtos por título, SKU ou código de barras
GET	/products/eligibility	Verifica a elegibilidade de vários produtos
POST	/products/register	Registra um produto para cobertura de garantia

Clientes

Método	Caminho	Descrição
GET	/customers/orders	Obtém os pedidos de um cliente

Registro

Método	Caminho	Descrição
GET	/registration/lookup	Consulta um registro pelo número

Números de série

Método	Caminho	Descrição
POST	/serial-numbers/validate	Valida um número de série

Análises

Método	Caminho	Descrição
POST	/analytics/events	Envia eventos de análise do widget

Configuração

Método	Caminho	Descrição
GET / POST	/config	Obtém a configuração e as traduções do widget

Status do pedido

Método	Caminho	Descrição
GET	/order-status	Obtém o status de um pedido

PDV

Método	Caminho	Descrição
GET	/pos/customer-search	Pesquisa clientes no contexto do PDV

Integração com a Shopify

Método	Caminho	Descrição
GET	/shopify/auth/callback	Callback OAuth da instalação do app
POST	/shopify/webhooks	Recebe eventos de Webhook da Shopify
POST	/shopify/post-purchase/sign-changeset	Assina os changesets da extensão pós-compra

Sincronização de produtos

Método	Caminho	Descrição
POST	/sync-products	Sincroniza os produtos de uma organização
POST	/sync-products/all	Sincroniza os produtos de todas as organizações

Integridade

Método	Caminho	Descrição
GET	/health	Verifica o status de integridade da API

Retorna 200 (íntegra), 206 (degradada) ou 503 (indisponível).

Relacionados

• Autenticação — Configuração da chave de API e limites de requisições
• API de garantias — Referência detalhada dos endpoints de garantia
• API de sinistros — Referência detalhada dos endpoints de sinistros
• API de apólices — Referência detalhada dos endpoints de apólices