Pular para o conteúdo

Notas do sistema

GET
/connect/systems/{systemId}/notes
curl --request GET \
--url https://api-connect.zoppy.com.br/connect/systems/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/notes \
--header 'Authorization: Bearer <token>'

O que se sabe do sistema para construir conectores: as notas oficiais primeiro, depois as aprendidas. Uma nota aprendida por outra loja só aparece depois de um ensaio limpo do conector que a escreveu; as desta loja aparecem já, marcadas como pendentes.

systemId
required

Id do sistema no catálogo

string format: uuid

Id do sistema no catálogo

Notas

Media typeapplication/json

Notas do sistema, as oficiais primeiro

Array<object>
object
id
required

Id da nota

string format: uuid
topic
required

Assunto da nota: documentation, authentication, pagination, limits ou pitfall

string
text
required

A nota, em uma linha em português

string
official
required

Escrita pela plataforma, não aprendida numa conversa

boolean
pending
required

Aprendida por esta loja e esperando um ensaio limpo antes de outras lojas verem

boolean
createdAt
required

Quando foi registrada

string format: date-time

Example generated

[
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"topic": "example",
"text": "example",
"official": true,
"pending": true,
"createdAt": "2026-04-15T12:00:00Z"
}
]

Entrada inválida (validation_failed)

Media typeapplication/json
object
type
required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string
title
required

Nome da classe do erro

string
status
required

Status HTTP

integer
detail
required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string
requestId
required

Id de correlação: passe ao suporte para achar o rastro completo

string
nullable
meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object
key
additional properties

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"requestId": "example",
"meta": {
"additionalProperty": "example"
}
}

Token ausente, inválido ou expirado (connect.unauthorized)

Media typeapplication/json
object
type
required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string
title
required

Nome da classe do erro

string
status
required

Status HTTP

integer
detail
required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string
requestId
required

Id de correlação: passe ao suporte para achar o rastro completo

string
nullable
meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object
key
additional properties

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"requestId": "example",
"meta": {
"additionalProperty": "example"
}
}

Papel sem acesso ou Connect não liberado (connect.forbidden_role, connect.feature_disabled)

Media typeapplication/json
object
type
required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string
title
required

Nome da classe do erro

string
status
required

Status HTTP

integer
detail
required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string
requestId
required

Id de correlação: passe ao suporte para achar o rastro completo

string
nullable
meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object
key
additional properties

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"requestId": "example",
"meta": {
"additionalProperty": "example"
}
}

Sistema fora do catálogo (connect.system_not_found)

Media typeapplication/json
object
type
required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string
title
required

Nome da classe do erro

string
status
required

Status HTTP

integer
detail
required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string
requestId
required

Id de correlação: passe ao suporte para achar o rastro completo

string
nullable
meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object
key
additional properties

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"requestId": "example",
"meta": {
"additionalProperty": "example"
}
}