Versions Compared

Version Old Version 1 New Version 2
Changes made by

Nicole de Marchi Leite

Lisiane Correia Ribeiro (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Para utilizar a API você precisa ter um ‘Usuário para API’ cadastrado, assim você terá acesso as às autorizações necessárias para utilização da API.

Info

Caso você ainda não possua, acesso as às autorizações, acesse a nossa documentação a respeito: Usuários para API

 

  1. O primeiro passo é realizar uma requisição POST utilizando a seguinte URL: $base/external_api_v2/access/internal/save

  2. Composição do

...

  1. JSON para novos usuários internos.

     

    Code Block
    [
  {
    "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

negocio

negócio a ser vinculada com o usuário.

Informe o nome da área de

negocio

negócio cadastrada na empresa. Caso o usuário possua mais de uma área a ser vinculada, separe por

virgula

vírgula as áreas.

Obs.: As áreas de

negocio

negócio são cadastradas

dentro da

na plataforma em: ‘Configurações’ > ‘Meus acessos’ > Selecione o botão ‘Áreas de

negocio’

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

:

.

  1. Acesse o modulo: ‘Configurações’ > ‘Minha empresa’ Selecione o menu ‘Outros’.

  2. No campo ‘Código de Relacionamento da Empresa’, cadastre o código que irá ser utilizado.

  3. Podendo adicionar um acesso em

varias

  1. várias empresas, adicionando o código de cada empresa.

email

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

virgulas

vírgulas.

Obs.: As funções são cadastras

dentro da

na 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:

  1. Ativo

  2. Inativo

  1. 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 JSON preenchido:

 

Code Block
[
  {
    "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
  }
]

...