Acesso à Zoppy

GET

/connect/zoppy-token

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

• Produção
• Staging

Se o acesso do Connect à Zoppy está ativo, revogado ou ainda não existe, e os conectores pausados pela revogação.

Authorizations

• bearer

Responses

200

Acesso

Media typeapplication/json

object

status

required

Acesso do Connect à Zoppy

string

Allowed values: active revoked missing

externalTokenId

required

Id do ExternalToken na Zoppy

string

nullable

createdByUserId

required

Quem gerou

string

nullable

createdAt

required

Instante em ISO 8601

string format: date-time

nullable

revokedAt

required

Instante em ISO 8601

string format: date-time

nullable

pausedConnectors

required

Conectores pausados porque o acesso foi revogado

Array<object>

object

id

required

Id do conector

string format: uuid

name

required

Nome do conector

string

Example

{
  "status": "active"
}

400

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

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