Atualizações de cadastro do cliente

Fila administrativa de alterações pedidas pelo cliente (portal/link). Preferências de comunicação e tokens de acesso.

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

GET /customer-profile-updates

Listar solicitações de alteração

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

const res = await fetch("https://api.nivesistemas.com.br/customer-profile-updates", {
  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/customer-profile-updates",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /customer-profile-updates/:id

Detalhe da solicitação

Parâmetros de rota: id

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

const res = await fetch("https://api.nivesistemas.com.br/customer-profile-updates/{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/customer-profile-updates/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /customer-profile-updates/:id/approve

Aprovar alteração de cadastro

Parâmetros de rota: id

curl -X POST "https://api.nivesistemas.com.br/customer-profile-updates/{id}/approve" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

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

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/customer-profile-updates/{id}/approve",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /customer-profile-updates/:id/reject

Rejeitar alteração de cadastro

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`reason`	string	não	Motivo da rejeição

curl -X POST "https://api.nivesistemas.com.br/customer-profile-updates/{id}/reject" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"reason":""}'

const res = await fetch("https://api.nivesistemas.com.br/customer-profile-updates/{id}/reject", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "reason": ""
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/customer-profile-updates/{id}/reject",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "reason": ""
    },
)
print(res.json())

GET /customer-profile-updates/by-customer/:customerId/preferences

Preferências de comunicação do cliente

Parâmetros de rota: customerId

curl -X GET "https://api.nivesistemas.com.br/customer-profile-updates/by-customer/{customerId}/preferences" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/customer-profile-updates/by-customer/{customerId}/preferences", {
  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/customer-profile-updates/by-customer/{customerId}/preferences",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

PATCH /customer-profile-updates/by-customer/:customerId/preferences

Atualizar preferências de comunicação

Parâmetros de rota: customerId

curl -X PATCH "https://api.nivesistemas.com.br/customer-profile-updates/by-customer/{customerId}/preferences" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/customer-profile-updates/by-customer/{customerId}/preferences", {
  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/customer-profile-updates/by-customer/{customerId}/preferences",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /customer-profile-updates/by-customer/:customerId/access-token

Gerar token de acesso ao portal do cliente

Parâmetros de rota: customerId

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`purpose`	string	não	Finalidade do token
`expiresInDays`	integer	não	Validade em dias

Resposta: 201 Created

curl -X POST "https://api.nivesistemas.com.br/customer-profile-updates/by-customer/{customerId}/access-token" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"purpose":"","expiresInDays":1}'

const res = await fetch("https://api.nivesistemas.com.br/customer-profile-updates/by-customer/{customerId}/access-token", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "purpose": "",
    "expiresInDays": 1
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/customer-profile-updates/by-customer/{customerId}/access-token",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "purpose": "",
      "expiresInDays": 1
    },
)
print(res.json())

POST /customer-profile-updates/by-customer/:customerId/unsubscribe-token

Gerar token de descadastro de notificações

Parâmetros de rota: customerId

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`preferenceKey`	string	não	Chave da preferência
`expiresInDays`	integer	não	Validade em dias

Resposta: 201 Created

curl -X POST "https://api.nivesistemas.com.br/customer-profile-updates/by-customer/{customerId}/unsubscribe-token" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"preferenceKey":"","expiresInDays":1}'

const res = await fetch("https://api.nivesistemas.com.br/customer-profile-updates/by-customer/{customerId}/unsubscribe-token", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "preferenceKey": "",
    "expiresInDays": 1
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/customer-profile-updates/by-customer/{customerId}/unsubscribe-token",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "preferenceKey": "",
      "expiresInDays": 1
    },
)
print(res.json())