Confirmar a primeira escrita

POST

/connectors/{connectorId}/external-writes/{heldWriteId}/confirm

const url = 'https://api-connect.zoppy.com.br/connectors/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/external-writes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/confirm';
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/external-writes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/confirm \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "token": "example" }'

Manda uma vez a escrita guardada, exatamente como está. Depois dela, as escritas do conector nesse sistema saem sem perguntar, até uma versão publicada escrever num sistema novo. O que vai para o outro sistema não tem desfazer.

Authorizations

bearer

Parameters

Path Parameters

connectorId

required

Id do conector

string format: uuid

Id do conector

heldWriteId

required

Id da escrita guardada

string format: uuid

Id da escrita guardada

Request Body^required

application/json

object

token

required

O token da prévia; vale 10 minutos e para esse estado da escrita

string

>= 1 characters

Example ^generated

{
  "token": "example"
}

Responses

200

Escrita enviada (ou já enviada antes)

application/json

object

required

string format: uuid

runId

required

Execução que guardou a escrita

string format: uuid

versionSeq

required

Versão do conector que pediu a escrita

integer

host

required

Sistema que recebe a escrita

string

status

required

Held espera a pessoa; confirmed ainda não saiu; sending saindo; sent saiu; failed pode ter chegado e nunca é repetida; discarded não sai mais

string

Allowed values: held confirmed sending sent failed discarded

method

required

string

url

required

Como o código pediu; segredos aparecem como marcadores

string

query

required

object

key

additional properties

string

headers

required

object

key

additional properties

string

body

required

Corpo com dados pessoais mascarados

string

nullable

heldAt

required

Instante ISO 8601

string format: date-time

confirmedAt

required

Instante ISO 8601

string format: date-time

nullable

confirmedByUserId

required

string

nullable

sentAt

required

Instante ISO 8601

string format: date-time

nullable

responseStatus

required

Status HTTP que o outro sistema respondeu

integer

nullable

failureCode

required

string

nullable

notice

required

Aviso para a pessoa quando a escrita pode ter chegado ao outro sistema

string

nullable

Example

{
  "status": "held"
}

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 ou escrita guardada de outra loja ou inexistente (connect.connector_not_found, connect.held_write_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 ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}

409

Connect.held_write_confirmation_refused (prévia vencida ou de outro estado), connect.held_write_decided (já saiu, está saindo ou foi trocada), connect.held_write_outdated (a versão publicada não escreve mais nesse sistema), connect.held_write_connector_paused (o conector está pausado: a escrita fica confirmada e sai sozinha quando ele for ligado de novo)

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

502

Connect.held_write_relay_failed: não saiu agora e continua confirmada; sai sozinha em até alguns minutos ou numa nova confirmação. connect.held_write_send_uncertain: falhou no meio do caminho, pode ter chegado e nunca é repetida

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

Confirmar a primeira escrita

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Example generated

Responses

200

Example

401

Example generated

403

Example generated

404

Example generated

409

Example generated

502

Example generated

Request Body^required

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated