Checklists de serviço

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

GET /service-checklists

Listar templates de checklist

curl -X GET "https://api.nivesistemas.com.br/service-checklists" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/service-checklists", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/service-checklists",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /service-checklists/responses

Listar respostas preenchidas

curl -X GET "https://api.nivesistemas.com.br/service-checklists/responses" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/service-checklists/responses", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/service-checklists/responses",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /service-checklists/:id

Detalhe do template

Parâmetros de rota: id

curl -X GET "https://api.nivesistemas.com.br/service-checklists/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/service-checklists/{id}", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/service-checklists/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /service-checklists

Criar template

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`name`	string	sim	Nome
`description`	string	não	Descrição
`active`	boolean	não	Ativo
`productId`	uuid	não	Produto vinculado

Resposta: 201 Created

curl -X POST "https://api.nivesistemas.com.br/service-checklists" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"name":"Exemplo","description":"","active":true,"productId":"00000000-0000-0000-0000-000000000000"}'

const res = await fetch("https://api.nivesistemas.com.br/service-checklists", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Exemplo",
    "description": "",
    "active": true,
    "productId": "00000000-0000-0000-0000-000000000000"
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/service-checklists",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "name": "Exemplo",
      "description": "",
      "active": True,
      "productId": "00000000-0000-0000-0000-000000000000"
    },
)
print(res.json())

PATCH /service-checklists/:id

Atualizar template

Parâmetros de rota: id

curl -X PATCH "https://api.nivesistemas.com.br/service-checklists/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/service-checklists/{id}", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "PATCH",
    "https://api.nivesistemas.com.br/service-checklists/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

DELETE /service-checklists/:id

Excluir template

Parâmetros de rota: id

Resposta: 204 No Content

curl -X DELETE "https://api.nivesistemas.com.br/service-checklists/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/service-checklists/{id}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "DELETE",
    "https://api.nivesistemas.com.br/service-checklists/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /service-checklists/:id/items

Adicionar item ao template

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`label`	string	sim	Rótulo
`itemType`	string	não	TEXT \| YES_NO \| NUMBER \| PHOTO \| SELECT
`required`	boolean	não	Obrigatório
`optionsJson`	array	não	Opções (SELECT)
`position`	integer	não	Ordem

Resposta: 201 Created

curl -X POST "https://api.nivesistemas.com.br/service-checklists/{id}/items" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"label":"","itemType":"","required":true,"optionsJson":[],"position":1}'

const res = await fetch("https://api.nivesistemas.com.br/service-checklists/{id}/items", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "label": "",
    "itemType": "",
    "required": true,
    "optionsJson": [],
    "position": 1
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/service-checklists/{id}/items",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "label": "",
      "itemType": "",
      "required": True,
      "optionsJson": [],
      "position": 1
    },
)
print(res.json())

PATCH /service-checklists/:id/items/:itemId

Atualizar item

Parâmetros de rota: id, itemId

curl -X PATCH "https://api.nivesistemas.com.br/service-checklists/{id}/items/{itemId}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/service-checklists/{id}/items/{itemId}", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "PATCH",
    "https://api.nivesistemas.com.br/service-checklists/{id}/items/{itemId}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

DELETE /service-checklists/:id/items/:itemId

Excluir item

Parâmetros de rota: id, itemId

Resposta: 204 No Content

curl -X DELETE "https://api.nivesistemas.com.br/service-checklists/{id}/items/{itemId}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/service-checklists/{id}/items/{itemId}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "DELETE",
    "https://api.nivesistemas.com.br/service-checklists/{id}/items/{itemId}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())