Ativar, desativar, bloquear e desbloquear uma pessoa

Como ativar/desativar o cadastro de pessoas no Zeev utilizando API?

Para ativar ou desativar o cadastro de pessoas no Zeev, siga estes passos:

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

2. Obtenha o userid: Obtenha código do usuário. É possível obter este identificador na página Acesso > Pessoas ou utilizando consulta de API's como nos exemplos que estão disponíveis em Listar pessoas;

3. Para desativar o cadastro: Enviar a requisição para Ativar, desativar, bloquear e desbloquear uma pessoa (troque seu_endereco.do.zeev pelo endereço que você utiliza para acessar o Zeev);

4. Para ativar o cadastro: Enviar requisição para Ativar, desativar, bloquear e desbloquear uma pessoa (troque seu_endereco.do.zeev pelo endereço que você utiliza para acessar o Zeev);

Obs: É necessário que a licença de uso do sistema permita a inclusão de uma nova pessoa ativa.

Ativar uma pessoa por código (Auth)

patch

Autorizações

AuthorizationstringObrigatório

Utilize um token válido de usuário para realizar a requisição

Parâmetros de rota

userIdinteger · int32Obrigatório

Código identificador da pessoa

Respostas

200

Sucesso.

successbooleanSomente leituraOpcional

Indica se houve sucesso

400

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

401

Pessoa não autorizada

403

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

404

O registro não foi encontrado

429

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

500

Ocorreu algum erro interno no servidor

patch/api/2/users/{userid}/account/activate

PATCH /api/2/users/{userid}/account/activate HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true
}

Exemplo de requisição para ativar o cadastro de uma pessoa no Zeev

Node.js

let userId = 890;
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/users/${userId}/account/activate`, requestOptions);
  const result = await response.text();
  console.log(result)
} catch (error) {
  console.error(error);
};

Desativar uma pessoa por código (Auth)

patch

Autorizações

AuthorizationstringObrigatório

Utilize um token válido de usuário para realizar a requisição

Parâmetros de rota

userIdinteger · int32Obrigatório

Código identificador da pessoa

Respostas

200

Sucesso.

successbooleanSomente leituraOpcional

Indica se houve sucesso na operação

400

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

401

Pessoa não autorizada

403

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

404

O registro não foi encontrado

429

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

500

Ocorreu algum erro interno no servidor

patch/api/2/users/{userid}/account/deactivate

PATCH /api/2/users/{userid}/account/deactivate HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true
}

Exemplo de requisição para desativar o cadastro de uma pessoa no Zeev

Node.js

let userId = 890;
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/users/${userId}/account/deactivate`, requestOptions);
  const result = await response.text();
  console.log(result)
} catch (error) {
  console.error(error);
};

---

Como bloquear/desbloquear acesso de uma pessoa ao Zeev por API?

Para bloquear ou desbloquear o acesso de pessoas no Zeev, siga estes passos:

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

2. Obtenha o userid: Obtenha código do usuário. É possível obter este identificador na página Acesso > Pessoas ou utilizando consulta de API's como nos exemplos que estão disponíveis em Listar pessoas;

3. Para bloquear o acesso: Enviar a requisição para Ativar, desativar, bloquear e desbloquear uma pessoa (troque seu_endereco.do.zeev pelo endereço que você utiliza para acessar o Zeev);

4. Para esbloquear o acesso: Enviar requisição para Ativar, desativar, bloquear e desbloquear uma pessoa (troque seu_endereco.do.zeev pelo endereço que você utiliza para acessar o Zeev);

O bloqueio impede o login no sistema. A pessoa, entretanto, ainda é capaz de receber tarefas e também consome licenciamento.

Bloquear o acesso de uma pessoa ao sistema por código (Auth)

patch

Autorizações

AuthorizationstringObrigatório

Utilize um token válido de usuário para realizar a requisição

Parâmetros de rota

userIdinteger · int32Obrigatório

Código identificador da pessoa

Respostas

200

Sucesso.

successbooleanOpcional

Indica se houve sucesso na operação

userIdinteger · int32Opcional

Identificador da pessoa

usernamestringOpcional

Login da pessoa

400

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

401

Pessoa não autorizada

403

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

404

O registro não foi encontrado

429

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

500

Ocorreu algum erro interno no servidor

patch/api/2/users/{userid}/account/lock

PATCH /api/2/users/{userid}/account/lock HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "userId": 1,
  "username": "text"
}

Exemplo de requisição para bloquear o acesso de uma pessoa

Node.js

let userId = 890;
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/users/${userId}/account/lock`, requestOptions);
  const result = await response.text();
  console.log(result)
} catch (error) {
  console.error(error);
};

Desbloquear o acesso de uma pessoa ao sistema por código (Auth)

patch

Autorizações

AuthorizationstringObrigatório

Utilize um token válido de usuário para realizar a requisição

Parâmetros de rota

userIdinteger · int32Obrigatório

Código identificador da pessoa

Respostas

200

Sucesso.

successbooleanOpcional

Indica se houve sucesso na operação

userIdinteger · int32Opcional

Identificador da pessoa

usernamestringOpcional

Login da pessoa

400

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

401

Pessoa não autorizada

403

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

404

O registro não foi encontrado

429

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

500

Ocorreu algum erro interno no servidor

patch/api/2/users/{userid}/account/unlock

PATCH /api/2/users/{userid}/account/unlock HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "userId": 1,
  "username": "text"
}

Exemplo de requisição para desbloquear o acesso de uma pessoa

Node.js

let userId = 890;
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/users/${userId}/account/unlock`, requestOptions);
  const result = await response.text();
  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

• Gerenciar pessoas