Página da documentação

GET

/connect/docs/{slug}

curl --request GET \
  --url https://api-connect.zoppy.com.br/connect/docs/example \
  --header 'Authorization: Bearer <token>'

• Produção
• Staging

Uma página da documentação do Connect em Markdown, em pt-BR, com os limites preenchidos pelos valores deste ambiente.

Authorizations

• bearer

Parameters

Path Parameters

slug

required

Id da página

string

<= 64 characters /^[a-z0-9]+(?:-[a-z0-9]+)*$/

Id da página

Responses

200

Página

Media typeapplication/json

object

slug

required

Id da página, o último segmento do caminho dela

string

<= 64 characters /^[a-z0-9]+(?:-[a-z0-9]+)*$/

path

required

Caminho da página no site da documentação, sem barras nas pontas

string

/^[a-z0-9-]+(?:\/[a-z0-9-]+)*$/

title

required

Título, em pt-BR

string

>= 1 characters

description

required

Resumo de uma frase, em pt-BR

string

>= 1 characters

order

required

integer

audience

required

Loja: equipe da loja, sem código; tecnico: quem lê código de conector; todos: todo mundo

string

Allowed values: loja tecnico todos

markdown

required

O corpo da página em Markdown, pt-BR, com os limites preenchidos

string

Example

{
  "audience": "loja"
}

400

Slug inválido (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"
  }
}

401

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"
  }
}

403

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"
  }
}

404

Página inexistente (connect.doc_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"
  }
}