API atual/Referência completa/Dashboards do seller

Compartilhamento

Publica uma aba para outras pessoas, lista com quem ela está compartilhada e remove um compartilhamento.

Compartilhar dá a outras pessoas acesso a uma aba. A pessoa que recebe vê a aba e os dados dela mesma: o que é compartilhado é a definição dos cards, não os números do dono. Só o dono (ou quem tem permissão de escrita) gerencia os compartilhamentos.

Publicar aba

Cria ou atualiza compartilhamentos da aba. Repetir um destinatário só atualiza a permissão dele.

POST/api/v1/vendor/dashboards/{id}/publishSeller

Publicar aba

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Content-Typestringobrigatório

application/json.

Parâmetros de caminho

iduuidobrigatório

Id da aba (UUID).

Corpo da requisição

principalsobject[]obrigatório

Destinatários.

principals[].typestringobrigatório

UGVS

Tipo: U usuário, G grupo de usuários, V um seller específico, S todos os sellers. A (todos os administradores) vale só para abas do administrador e é recusado aqui.

principals[].iduuid

Id do usuário, grupo ou seller. Obrigatório, exceto em S.

principals[].permissionstringpadrão: R

RW

R só leitura ou W leitura e escrita.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/dashboards/931b3fc7-e703-4cac-bcbc-5c79690f02a8/publish" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"principals": [{"type": "V", "id": "ce822da6-5869-4819-b8bb-9aefd2e62925", "permission": "R"}]}'

Resposta

200Publicada

json

{
  "message": "dashboard published"
}

Erros

Status	Quando	Corpo de exemplo
404	A aba não existe, é de outro seller ou você não pode vê-la. A API responde `404` nos três casos para não revelar que ela existe.	`{"error":"dashboard not found"}`
400	Corpo que não é JSON, tipo inválido, `id` ausente, ou `type` igual a `A`.	`{"error":"failed to publish dashboard","detail":"principal type \"A\" (every administrator) ..."}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, ou a loja ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`

Listar compartilhamentos

GET/api/v1/vendor/dashboards/{id}/sharesSeller

Listar compartilhamentos

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

iduuidobrigatório

Id da aba (UUID).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/dashboards/931b3fc7-e703-4cac-bcbc-5c79690f02a8/shares" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Compartilhamentos

json

{
  "shares": [
    {
      "id": "3a1f0a5c-8d0c-4f55-9b0a-5a2f6a0f7c11",
      "dashboard_id": "931b3fc7-e703-4cac-bcbc-5c79690f02a8",
      "principal_type": "V",
      "principal_id": "ce822da6-5869-4819-b8bb-9aefd2e62925",
      "permission": "R",
      "shared_by": "0fd409fb-9869-4c50-a18c-a810a19abeed",
      "created_at": "2026-10-11T22:00:00Z"
    }
  ]
}

Campos da resposta

sharesobject[]|null

Os compartilhamentos, do mais antigo ao mais novo. null quando não há nenhum.

shares[].iduuid

Id do compartilhamento; use em Remover.

shares[].dashboard_iduuid

Aba.

shares[].principal_typestring

U, G, V, S ou A.

shares[].principal_iduuid

Destinatário. Ausente em S e A.

shares[].permissionstring

R ou W.

shares[].shared_byuuid

Quem compartilhou.

shares[].created_atstring

Quando, RFC 3339 em UTC.

Erros

Status	Quando	Corpo de exemplo
404	A aba não existe, é de outro seller ou você não pode vê-la. A API responde `404` nos três casos para não revelar que ela existe.	`{"error":"dashboard not found"}`
500	Falha ao listar.	`{"error":"failed to list shares"}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, ou a loja ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`

Remover compartilhamento

DELETE/api/v1/vendor/dashboards/{id}/shares/{shareId}Seller

Remover compartilhamento

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

iduuidobrigatório

Id da aba (UUID).

shareIduuidobrigatório

Id do compartilhamento (UUID), de Listar compartilhamentos.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/v1/vendor/dashboards/931b3fc7-e703-4cac-bcbc-5c79690f02a8/shares/3a1f0a5c-8d0c-4f55-9b0a-5a2f6a0f7c11" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Removido

json

{
  "message": "share removed"
}

Erros

Status	Quando	Corpo de exemplo
404	Aba inexistente ou alheia, ou compartilhamento inexistente.	`{"error":"share not found"}`
500	Falha ao remover.	`{"error":"failed to remove share"}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, ou a loja ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`

Veja também

API atual/Referência completa/Dashboards do seller

Compartilhamento

Publica uma aba para outras pessoas, lista com quem ela está compartilhada e remove um compartilhamento.

Publicar aba

Cria ou atualiza compartilhamentos da aba. Repetir um destinatário só atualiza a permissão dele.

POST/api/v1/vendor/dashboards/{id}/publishSeller

Publicar aba

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Content-Typestringobrigatório

application/json.

Parâmetros de caminho

iduuidobrigatório

Id da aba (UUID).

Corpo da requisição

principalsobject[]obrigatório

Destinatários.

principals[].typestringobrigatório

UGVS

Tipo: U usuário, G grupo de usuários, V um seller específico, S todos os sellers. A (todos os administradores) vale só para abas do administrador e é recusado aqui.

principals[].iduuid

Id do usuário, grupo ou seller. Obrigatório, exceto em S.

principals[].permissionstringpadrão: R

RW

R só leitura ou W leitura e escrita.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/dashboards/931b3fc7-e703-4cac-bcbc-5c79690f02a8/publish" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"principals": [{"type": "V", "id": "ce822da6-5869-4819-b8bb-9aefd2e62925", "permission": "R"}]}'

Resposta

200Publicada

json

{
  "message": "dashboard published"
}

Erros

Status	Quando	Corpo de exemplo
404	A aba não existe, é de outro seller ou você não pode vê-la. A API responde `404` nos três casos para não revelar que ela existe.	`{"error":"dashboard not found"}`
400	Corpo que não é JSON, tipo inválido, `id` ausente, ou `type` igual a `A`.	`{"error":"failed to publish dashboard","detail":"principal type \"A\" (every administrator) ..."}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, ou a loja ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`

Listar compartilhamentos

GET/api/v1/vendor/dashboards/{id}/sharesSeller

Listar compartilhamentos

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

iduuidobrigatório

Id da aba (UUID).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/dashboards/931b3fc7-e703-4cac-bcbc-5c79690f02a8/shares" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Compartilhamentos

json

{
  "shares": [
    {
      "id": "3a1f0a5c-8d0c-4f55-9b0a-5a2f6a0f7c11",
      "dashboard_id": "931b3fc7-e703-4cac-bcbc-5c79690f02a8",
      "principal_type": "V",
      "principal_id": "ce822da6-5869-4819-b8bb-9aefd2e62925",
      "permission": "R",
      "shared_by": "0fd409fb-9869-4c50-a18c-a810a19abeed",
      "created_at": "2026-10-11T22:00:00Z"
    }
  ]
}

Campos da resposta

sharesobject[]|null

Os compartilhamentos, do mais antigo ao mais novo. null quando não há nenhum.

shares[].iduuid

Id do compartilhamento; use em Remover.

shares[].dashboard_iduuid

Aba.

shares[].principal_typestring

U, G, V, S ou A.

shares[].principal_iduuid

Destinatário. Ausente em S e A.

shares[].permissionstring

R ou W.

shares[].shared_byuuid

Quem compartilhou.

shares[].created_atstring

Quando, RFC 3339 em UTC.

Erros

Status	Quando	Corpo de exemplo
404	A aba não existe, é de outro seller ou você não pode vê-la. A API responde `404` nos três casos para não revelar que ela existe.	`{"error":"dashboard not found"}`
500	Falha ao listar.	`{"error":"failed to list shares"}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, ou a loja ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`

Remover compartilhamento

DELETE/api/v1/vendor/dashboards/{id}/shares/{shareId}Seller

Remover compartilhamento

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

iduuidobrigatório

Id da aba (UUID).

shareIduuidobrigatório

Id do compartilhamento (UUID), de Listar compartilhamentos.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/v1/vendor/dashboards/931b3fc7-e703-4cac-bcbc-5c79690f02a8/shares/3a1f0a5c-8d0c-4f55-9b0a-5a2f6a0f7c11" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Removido

json

{
  "message": "share removed"
}

Erros

Status	Quando	Corpo de exemplo
404	Aba inexistente ou alheia, ou compartilhamento inexistente.	`{"error":"share not found"}`
500	Falha ao remover.	`{"error":"failed to remove share"}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, ou a loja ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`