Pular para o conteúdo
Zoppy ConnectZoppy ConnectZoppy Connect

Publicar

POST
/connectors/{connectorId}/publish
curl --request POST \
  --url https://api-connect.zoppy.com.br/connectors/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/publish \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "token": "example" }'

Publica a versão mais nova com o token da prévia.

Authorizations

Seção intitulada “Authorizations”

Parameters

Seção intitulada “Parameters”

Path Parameters

Seção intitulada “Path Parameters”
connectorId
required

Id do conector

string format: uuid

Id do conector

Request Bodyrequired

Seção intitulada “Request Bodyrequired”
Media typeapplication/json
object
token
required

Token da prévia

string
>= 1 characters

Example generated

{
  "token": "example"
}

Responses

Seção intitulada “Responses”

200

Seção intitulada “200”

Conector

Media typeapplication/json
object
id
required

Id do conector

string format: uuid
name
required

Nome que a loja deu ao conector

string
description
required

O que o conector faz

string
nullable
systemId
required

Sistema do catálogo de onde ele partiu

string format: uuid
nullable
status
required

Draft, enabled ou paused

string
Allowed values: draft enabled paused
pausedReason
required

Por que está pausado: manual, failures, emergency ou zoppy_token_revoked

string
nullable
Allowed values: manual failures emergency zoppy_token_revoked
pausedAt
required

Instante em ISO 8601

string format: date-time
nullable
headSeq
required

Versão mais nova, publicada ou não; null antes da primeira

integer
nullable
publishedSeq
required

Versão que roda de verdade

integer
nullable
scheduleEveryMinutes
required

Intervalo do cron da versão publicada

integer
nullable
nextRunAt
required

Instante em ISO 8601

string format: date-time
nullable
approvedHosts
required

Hosts que uma pessoa aprovou para os ensaios

Array<string>
pendingHosts
required

Hosts da versão mais nova ainda esperando aprovação

Array<string>
createdAt
required

Quando foi criado

string format: date-time
updatedAt
required

Última alteração

string format: date-time
direction
required

De onde vêm e para onde vão os dados, pelo sistema do catálogo e pelo manifesto; null enquanto não está claro

object
source
required

Slug do sistema do catálogo de onde vêm os dados (zoppy para a Zoppy)

string
target
required

Slug do sistema do catálogo para onde vão os dados (zoppy para a Zoppy)

string
lastRun
required

A execução mais recente, ensaios inclusos; null antes da primeira

object
id
required

Id da execução

string format: uuid
status
required

Running, succeeded, partial, failed ou timed_out

string
Allowed values: running succeeded partial failed timed_out
mode
required

Live escreve de verdade; dry_run é um ensaio

string
Allowed values: live dry_run
startedAt
required

Quando começou

string format: date-time
finishedAt
required

Instante em ISO 8601

string format: date-time
nullable
counters
required

Contagens do ctx.count, por objeto e tipo (read, created, updated, skipped, failed)

object
key
additional properties
object
key
additional properties
integer
quarantined
required

Registros que a execução mandou para a quarentena

integer
heldWritesCount
required

Escritas em outros sistemas guardadas ou confirmadas, esperando para sair

integer
agentId
required

Primeiro agente local do manifesto (da versão publicada ou, antes de publicar, da mais nova)

string
nullable

Example 

{
  "status": "draft",
  "pausedReason": "manual",
  "lastRun": {
    "status": "running",
    "mode": "live"
  }
}

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”

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

Seção intitulada “404”

Conector de outra loja ou inexistente (connect.connector_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 

{
  "type": "connect.connector_not_found",
  "title": "Não encontramos esse conector.",
  "status": 404
}

409

Seção intitulada “409”

O conector mudou depois da prévia ou o token já foi usado (connect.confirmation_stale); token expirado ou de outra prévia (connect.confirmation_refused); Versão sem ensaio limpo que leu a origem inteira (connect.not_rehearsed), ou cujo último ensaio criou registros sem consultar antes (connect.write_without_lookup); Estado do conector não permite a mudança (connect.connector_transition_refused)

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