Pular para o conteúdo
Zoppy ConnectZoppy ConnectZoppy Connect

Garantir o acesso à Zoppy

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

Chamado ao entrar: gera um novo ExternalToken quando não há um ativo e devolve a prévia para religar os conectores pausados pela revogação.

Authorizations

Seção intitulada “Authorizations”

Responses

Seção intitulada “Responses”

200

Seção intitulada “200”

Acesso e prévia

Media typeapplication/json
object
token
required

Acesso depois da chamada

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
reenable
required

Prévia para religar os conectores pausados; null quando nenhum está pausado

object
title
required

O que vai acontecer, em português

string
changes
required

Cada consequência, em português

Array<string>
token
required

Mande de volta para aplicar; vale por 10 minutos e só para este estado

string
expiresAt
required

Quando o token deixa de valer

string format: date-time

Example 

{
  "token": {
    "status": "active"
  }
}

400

Seção intitulada “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

Seção intitulada “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

Seção intitulada “403”

Loja no plano gratuito da Zoppy (connect.zoppy_free_tier)

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

503

Seção intitulada “503”

Zoppy indisponível (connect.zoppy_token_unavailable)

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