API — Criação de Usuários Internos
- Cassiano Gil Trainini
- Lisiane Correia Ribeiro (Unlicensed)
- camilla.hossein (Unlicensed)
Esta API é utilizada para criar usuários internos na plataforma Privacy Tools, abaixo estaremos exibindo o passo a passo para configuração desta API.
Para utilizar a API você precisa ter um ‘Usuário para API’ cadastrado, assim você terá acesso às autorizações necessárias para utilização da API.
Caso você ainda não possua, acesso às autorizações, acesse a nossa documentação a respeito: Usuários para APIarchived
O primeiro passo é realizar uma requisição POST utilizando a seguinte URL: $base/external_api_v2/access/internal/save
Composição do JSON para novos usuários internos.
[ { "areas": "string", "companyCode": "string", "email": "string", "expirationDate": "string", "functions": "string", "name": "string", "profile": "string", "role": "string", "statusId": 0 } ]
Parâmetros | Significado | Onde encontrar? |
|---|---|---|
areas | Área de negócio a ser vinculada com o usuário. | Informe o nome da área de negócio cadastrada na empresa. Caso o usuário possua mais de uma área a ser vinculada, separe por vírgula as áreas.Obs.: As áreas de negócio são cadastradas dentro da plataforma em: ‘Configurações’ > ‘Meus acessos’ > Selecione o botão, ‘Áreas de negócio’ > Pressione o botão ‘Adicionar’. |
companyCode | Código da companhia onde o usuário será cadastrado. | Necessário cadastrar o código de empresa. Para efetuar este cadastro e obter o código:
|
E-mail a ser cadastrado para o usuário. |
| |
expirationDate | Data de expiração a ser cadastrada. | Padrão utilizado: dd-MM-yyyy HH:mm |
functions | Funções que o usuário exerce. | Informe o código da função. Caso o usuário possua mais de uma função, separe os códigos de função por vírgulas.Obs.: As funções são cadastras dentro da plataforma em: ‘Configurações’ > ‘Meus acessos’ > Selecione o botão ‘Funções’ > Pressione o botão ‘Adicionar’. |
name | Nome do usuário. |
|
profile | Perfil do usuário | Possível utilizar os padrões da plataforma: access, company, admin, finance, website |
role | Cargo atribuído ao usuário. | Preencha com o nome do cargo. |
statusId | Status do usuário a ser cadastrado. | Códigos possíveis de utilizar e seu significado:
|
Após o envio da requisição, o usuário cadastrado, receberá um link para cadastro de senha em sua caixa de e-mails.
Exemplo JSON preenchido:
[
{
"areas": "Financeiro,Area de teste",
"companyCode": "9999",
"email": "email@privacytools.com.br",
"expirationDate": "22-05-2099 00:00",
"functions": "01,02",
"name": "Suporte Teste",
"profile": "admin",
"role": "Tecnico",
"statusId": 1
}
]Ressaltamos que a inativação não pode ser desfeita, caso precise ativar novamente o usuário terá que criar um novo e-mail.