Gerenciar senhas

Os endpoints existentes aqui apenas se aplicam para pessoas cadastradas com o tipo de autenticação interna, ou seja, em situações em que o a senha da pessoa é gerenciada pelo Zeev.

Como obter o link para troca de senha utilizando API?

Para obter o link de alteração de senha utilizando API, siga os passos abaixo:

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. Enviar a Requisição: Utilize o endpoint Gerenciar senhas para enviar a requisição conforme modelo e exemplo (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev);

Pegar link e chave de alteração de senha (Auth)

get

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.

linkstringOpcional

Link para troca de senha

keystringOpcional

Chave

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

get/api/2/users/{userid}/password/change-link

GET /api/2/users/{userid}/password/change-link HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

{
  "link": "text",
  "key": "text"
}

Exemplo de requisição para obter o link de troca de senha utilizando API

Node.js

let userId = 951;

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: "GET",
  headers: myHeaders
};

try {
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/users/${userId}/password/change-link` requestOptions);
  const result = await response.text();
  console.log(result)
} catch (error) {
  console.error(error);
};

---

Como forçar o usuário a trocar de senha no próximo login utilizando API?

Para forçar o usuário a trocar de senha da próxima vez que tentar se autenticar, siga os passos abaixo:

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. Enviar a Requisição: Utilize o endpoint Gerenciar senhas para enviar a requisição conforme modelo e exemplo (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev);

Forçar pessoa a alterar sua senha no próximo login (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}/password/force-change

PATCH /api/2/users/{userid}/password/force-change HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

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

Exemplo de requisição para forçar a troca de senha no próximo login da pessoa

Node.js

let userId = 753;

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}/password/force-change`, requestOptions);
  const result = await response.text();
  console.log(result)
} catch (error) {
  console.error(error);
};

---

Como enviar e-mail para redefinição de senha utilizando API?

Para solicitar a troca de senha a uma pessoa por e-mail, siga os passos abaixo:

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. Enviar a Requisição: Utilize o endpoint Gerenciar senhas para enviar a requisição conforme modelo e exemplo em (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev);

Enviar e-mail para pessoa definir nova senha (Auth)

post

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

emailstringOpcional

Endereço de e-mail 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

post/api/2/users/{userid}/password/request-reset

POST /api/2/users/{userid}/password/request-reset HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "email": "text"
}

Exemplo de requisição para envio de e-mail de redefinição de senha

Node.js

let userId = 159;

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: "POST",
  headers: myHeaders
};

try {
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/users/${userId}/password/request-reset`, 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