Cancelar ou reverter cancelamento de solicitações

Como cancelar instâncias de solicitações utilizando as API's do Zeev?

Para cancelar uma instância de solicitação utilizando as API's do Zeev, siga os passos abaixo:

1. Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;

2. Identificar a Solicitação: O Id é o código único da solicitação, você pode encontrar ele buscando em monitorar -> solicitações, ou utilizando o endpoint de API do Zeev para consultar instâncias através de filtros conforme descrito em Listar todas as solicitações do sistema;

3. Enviar a Requisição: Utilize o endpoint Cancelar ou reverter cancelamento de solicitações para enviar a requisição conforme modelo e exemplo (Troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev):

Cancelar uma instância de solicitação por código da solicitação (Auth)

patch

Parâmetros de rota

instanceIdinteger · int32Obrigatório

Código da solicitação

Corpo

application/json

reasonstringObrigatório

Motivo do cancelamento

Respostas

200

Sucesso

application/jsontext/jsontext/xml

400

Solicitação ou dados da solicitação são inválidas

application/jsontext/jsontext/xml

401

Pessoa não autorizada

application/jsontext/jsontext/xml

403

Pessoa não tem permissão de executar essa operação

application/jsontext/jsontext/xml

404

O registro não foi encontrado

application/jsontext/jsontext/xml

429

Muitas requisições em um determinado período de tempo

application/jsontext/jsontext/xml

500

Ocorreu algum erro interno no servidor

application/jsontext/jsontext/xml

patch

/api/2/instances/{instanceid}/cancel

HTTPcURLJavaScriptPython

PATCH /api/2/instances/{instanceid}/cancel HTTP/1.1
Host: seu_endereco.do.zeev
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "reason": "Aqui vai o motivo pelo qual a instância está sendo cancelada"
}

{
  "success": true
}

Exemplos de requisição

Node.js

let instanceId = 1234;

const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const raw = JSON.stringify({
  "reason": "Aqui vai o motivo pelo qual a instância está sendo cancelada"
});

const requestOptions = {
  method: "PATCH",
  headers: myHeaders,
  body: raw
};

try {
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/instances/${instanceId}/cancel`, requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
};

---

Como reverter o cancelamento de uma instância de solicitação utilizando as API's do Zeev?

Para reverter o cancelamento de uma instância de solicitação utilizando as API's do Zeev, siga os passos abaixo:

1. Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;

2. Identificar a Solicitação: O Id é o código único da solicitação, você pode encontrar ele buscando em monitorar -> solicitações, ou utilizando o endpoint de API do Zeev para consultar instâncias através de filtros conforme descrito em Listar todas as solicitações do sistema;

3. Enviar a Requisição: Utilize o endpoint Cancelar ou reverter cancelamento de solicitações para enviar a requisição conforme modelo e exemplo (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev):

Reverter cancelamento de uma instância de solicitação por código da solicitação (Auth)

patch

Parâmetros de rota

instanceIdinteger · int32Obrigatório

Código da solicitação

Respostas

200

Sucesso

application/jsontext/jsontext/xml

400

Solicitação ou dados da solicitação são inválidas

application/jsontext/jsontext/xml

401

Pessoa não autorizada

application/jsontext/jsontext/xml

403

Pessoa não tem permissão de executar essa operação

application/jsontext/jsontext/xml

404

O registro não foi encontrado

application/jsontext/jsontext/xml

429

Muitas requisições em um determinado período de tempo

application/jsontext/jsontext/xml

500

Ocorreu algum erro interno no servidor

application/jsontext/jsontext/xml

patch

/api/2/instances/{instanceid}/cancel/undo

HTTPcURLJavaScriptPython

PATCH /api/2/instances/{instanceid}/cancel/undo HTTP/1.1
Host: seu_endereco.do.zeev
Accept: */*

{
  "success": true
}

Exemplo de requisição

Node.js

let instanceId = 1234;

const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const requestOptions = {
  method: "PATCH",
  headers: myHeaders
};

try {
  const response = await fetch($`https://seu_endereco.do.zeev/api/2/instances/${instanceId}/cancel/undo`, requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
};

Links relacionados:

• O que é preciso para fazer integrações do Zeev para outros sistemas?

• Como autenticar nas APIs do Zeev

• Como controlar o volume máximo de requisições à APIs

• Como acessar o Swagger / OpenAPI