Pular para o conteúdo

Rotas públicas (sem autenticação)

Estas rotas não usam chave de API.

Base: https://api.nivesistemas.com.br · 59 endpoints

Health check — { ok, service }

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/health" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Obter avaliação pendente (link enviado ao cliente)

Parâmetros de rota: token

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/reviews/{token}" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Enviar resposta de avaliação

Parâmetros de rota: token

Corpo (JSON)

Campo Tipo Obrigatório Descrição
rating integer sim Nota de 1 a 5
npsScore integer sim NPS de 0 a 10
comment string não Comentário opcional
Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/public/reviews/{token}" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo" \
-H "Content-Type: application/json" \
-d '{"rating":1,"npsScore":1,"comment":""}'

Resumo da venda para checkout por link (sem login)

Parâmetros de rota: token

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/checkout/{token}" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Public Key MP e flags do checkout online

Parâmetros de rota: token

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/checkout/{token}/config" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Identificar/atualizar cliente no checkout

Parâmetros de rota: token

Corpo (JSON)

Campo Tipo Obrigatório Descrição
name string sim Nome completo
cpf string sim CPF do cliente
email string sim E-mail
phone string sim Telefone
confirmUpdate boolean não Confirma alteração de cadastro existente
Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/public/checkout/{token}/customer" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo" \
-H "Content-Type: application/json" \
-d '{"name":"Exemplo","cpf":"","email":"","phone":"","confirmUpdate":true}'

Formas de pagamento disponíveis (à vista/a prazo)

Parâmetros de rota: token

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/checkout/{token}/payment-conditions" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Criar cobrança PIX ou cartão online

Parâmetros de rota: token

Corpo (JSON)

Campo Tipo Obrigatório Descrição
channel string sim PIX ou CARD
paymentMethodId string sim ID da forma de pagamento
priceBasis string sim CASH ou CREDIT
cardToken string não Token do Payment Brick (cartão)
installments integer não Parcelas (cartão)
Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/public/checkout/{token}/charge" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo" \
-H "Content-Type: application/json" \
-d '{"channel":"","paymentMethodId":"","priceBasis":"","cardToken":"","installments":1}'

GET /public/checkout/:token/charge/:chargeId/status

Seção intitulada “GET /public/checkout/:token/charge/:chargeId/status”

Status da cobrança (polling UX; confirmação via webhook)

Parâmetros de rota: token, chargeId

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/checkout/{token}/charge/{chargeId}/status" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Obter configurações

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/convenience/settings" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Horários disponíveis

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/convenience/slots" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Catálogo público online

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/convenience/catalog" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Zonas de entrega

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/convenience/zones" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Solicitar código de autenticação

Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/public/convenience/auth/request-code" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Validar código de autenticação

Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/public/convenience/auth/verify-code" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Cliente autenticado (catálogo online)

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/convenience/me" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Atualizar perfil (catálogo online)

Janela do terminal
curl -X PATCH "https://api.nivesistemas.com.br/public/convenience/me" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Listar endereços

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/convenience/addresses" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Criar endereço

Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/public/convenience/addresses" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Atualizar endereço

Parâmetros de rota: id

Janela do terminal
curl -X PUT "https://api.nivesistemas.com.br/public/convenience/addresses/{id}" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Excluir endereço

Parâmetros de rota: id

Janela do terminal
curl -X DELETE "https://api.nivesistemas.com.br/public/convenience/addresses/{id}" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Criar pedido (catálogo online)

Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/public/convenience/orders" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Listar pedidos

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/convenience/orders" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Detalhe

Parâmetros de rota: id

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/convenience/orders/{id}" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Registrar abertura do checkout

Parâmetros de rota: token

Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/public/checkout/{token}/open" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Prévia do total do checkout

Parâmetros de rota: token

Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/public/checkout/{token}/preview-total" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Readiness check

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/health/ready" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Status dos pools

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/health/pools" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Especificação OpenAPI (parcial)

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/openapi.json" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Status de manutenção da plataforma

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/platform-status" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Localizar loja por CPF/CNPJ

Query params

Campo Tipo Obrigatório Descrição
document string não CPF (11) ou CNPJ (14 dígitos)
cnpj string não Alias de document
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/store-lookup" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Portal público da OS (token)

Parâmetros de rota: token

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/service-orders/{token}" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Enviar satisfação no portal da OS

Parâmetros de rota: token

Corpo (JSON)

Campo Tipo Obrigatório Descrição
score integer sim Nota de 1 a 5
comment string não Comentário
Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/public/service-orders/{token}/satisfaction" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo" \
-H "Content-Type: application/json" \
-d '{"score":1,"comment":""}'

Nome e logo da loja (portal do cliente)

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/customer-profile/store" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Perfil do cliente (JWT do catálogo online ou token de acesso)

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/customer-profile/me" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Solicitações de alteração do próprio cliente

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/customer-profile/requests" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Pedir alteração de cadastro

Corpo (JSON)

Campo Tipo Obrigatório Descrição
changes object sim Campos alterados
source string não PORTAL | SECURE_LINK | PERIODIC_PROMPT
Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/public/customer-profile/requests" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo" \
-H "Content-Type: application/json" \
-d '{"changes":null,"source":""}'

POST /public/customer-profile/requests/pending/cancel

Seção intitulada “POST /public/customer-profile/requests/pending/cancel”

Cancelar solicitação pendente do próprio cliente

Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/public/customer-profile/requests/pending/cancel" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Preferências de comunicação

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/customer-profile/preferences" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Atualizar preferências de comunicação

Janela do terminal
curl -X PATCH "https://api.nivesistemas.com.br/public/customer-profile/preferences" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Info do descadastro de notificações

Parâmetros de rota: token

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/unsubscribe/{token}" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Confirmar descadastro de notificações

Parâmetros de rota: token

Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/public/unsubscribe/{token}" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Alias em português de GET /unsubscribe/:token

Parâmetros de rota: token

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/notificacoes/desativar/{token}" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Alias em português de POST /unsubscribe/:token

Parâmetros de rota: token

Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/public/notificacoes/desativar/{token}" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Callback InfiniteTap (loja no path) — redireciona para a UI

Parâmetros de rota: loja

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/infinity-tap/{loja}/callback" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Callback InfiniteTap (loja via header/query)

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/infinity-tap/callback" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Health do webhook Mercado Pago

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/mercadopago/webhook" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Receber notificação Mercado Pago (use ?loja=)

Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/mercadopago/webhook" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Health do webhook SuperFrete

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/webhooks/superfrete" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Receber notificação SuperFrete (use ?loja=)

Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/webhooks/superfrete" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Criar pedido sem cadastro (nome, telefone, endereço, itens, pagamento)

Resposta: 201 Created

Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/public/convenience/orders/guest" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Registrar acesso ao catálogo (métrica)

Corpo (JSON)

Campo Tipo Obrigatório Descrição
catalogo string não Slug do catálogo

Resposta: 204 No Content

Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/public/convenience/catalog-access" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo" \
-H "Content-Type: application/json" \
-d '{"catalogo":""}'

Pontos de fidelidade do cliente logado no catálogo

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/convenience/loyalty" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Pontos de fidelidade no portal do cliente (token)

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/customer-profile/loyalty" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Cliente confirma presença no horário

Parâmetros de rota: token

Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/public/service-orders/{token}/confirm" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Cliente avisa que não poderá ir

Parâmetros de rota: token

Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/public/service-orders/{token}/decline" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

PDF da nota fiscal enviado ao cliente por link assinado (sem login)

Parâmetros de rota: file

Query params

Campo Tipo Obrigatório Descrição
exp string sim Expiração do link
sig string sim Assinatura do link

Resposta: :file é o id do documento fiscal seguido de .pdf. Retorna application/pdf inline; 404 se o link for inválido ou expirado. Os links são gerados pelo vendedor (app), não pela API de integração.

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/nota/{file}" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Redireciona para a página pública de rastreio da transportadora (destino do botão “Rastrear pedido” do WhatsApp)

Parâmetros de rota: shipmentId

Query params

Campo Tipo Obrigatório Descrição
loja string não Slug da loja (alternativa ao header X-Store-Slug)

Resposta: 302 para a URL de rastreio da transportadora. 404 se o envio não existe ou ainda não tem rastreio.

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/public/rastreio/{shipmentId}" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Oficina: o cliente aprova ou recusa o orçamento pelo link do portal da OS

Parâmetros de rota: token

Corpo (JSON)

Campo Tipo Obrigatório Descrição
decision string sim APPROVE ou DECLINE
comment string não Comentário (até 2000)

Resposta: { ok, decision, status, quoteApprovedAt, quoteDeclinedAt, needsReapproval }. 404 se o link é inválido; 400 se o orçamento venceu ou não está aguardando resposta; 409 se o orçamento já foi aprovado e o cliente tenta recusar.

Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/public/service-orders/{token}/quote-decision" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo" \
-H "Content-Type: application/json" \
-d '{"decision":"","comment":""}'