Ligar

POST

/connectors/{connectorId}/enable

const url = 'https://api-connect.zoppy.com.br/connectors/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/enable';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"token":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Liga o conector publicado com o token da prévia; a primeira execução sai agora.

Authorizations

bearer

Parameters

Path Parameters

connectorId

required

Id do conector

string format: uuid

Id do conector

Request Body^required

application/json

object

token

required

Token da prévia

string

>= 1 characters

Example ^generated

{
  "token": "example"
}

Responses

200

Conector

application/json

object

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

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

Entrada inválida (validation_failed)

application/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)

application/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)

application/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

Conector de outra loja ou inexistente (connect.connector_not_found)

application/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

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); Estado do conector não permite a mudança (connect.connector_transition_refused)

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

Ligar

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Example generated

Responses

200

Example

400

Example generated

401

Example generated

403

Example generated

404

Example

409

Example generated

Request Body^required

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated