Corbee Gestão

Cadastro de usuário

POST

/api/v2/users

Requisição

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Exemplo:

Authorization: Bearer ********************

Parâmetros Query

nome_completo

string

requerido

string

opcional

cpf

string

requerido

string

opcional

orgao_emissor

string

opcional

string

requerido

data_nascimento

string

requerido

Formato: 'AAAA-MM-DD'

id_perfil

integer

requerido

Pode ser obitido no endpoint de lista de perfis:
https://docs.gestao.corbee.com.br/perfis-de-usuarios

id_centro_custo

integer

requerido

Pode ser obitido no endpoint de listagem de centro de custos:
https://docs.gestao.corbee.com.br/centro-de-custos

dias_utilizacao_semana

string

opcional

dias da semana de 1 a 7 separados por vírgula

Exemplo:

1,2,3,4,5,6,7

horario_permitido_inicio

string

opcional

Hora no formato: HH:MM:SS

Exemplo:

00:00:00

horario_permitido_fim

string

opcional

Hora no formato: HH:MM:SS

Exemplo:

23:59:59

id_loja

integer

opcional

Pode ser obitido no endpoint de listagem de lojas:
https://docs.gestao.corbee.com.br/lojas

sexo

enum<string>

requerido

Valores permitidos:

estado_civil

enum<string>

requerido

Valores permitidos:

divorciadoviuvocasadosolteirooutro

atende_telemarketing

boolean

opcional

gerente_corretores

boolean

opcional

acessa_area_gerentes

boolean

opcional

salario

number

opcional

Necessário apenas se for Gerente de corretores

ajuda_custo

number

opcional

Necessário apenas se for Gerente de corretores

fuso_horario_agenda

enum<string>

opcional

Fuso horário para agenda, caso necessário

Valores permitidos:

ACTAMTBRTFNT

senha_expira

boolean

opcional

visivel_corretores

boolean

opcional

ramal_pabx

string

opcional

utiliza_mfa

boolean

opcional

id_corretor

integer

opcional

Código do corretor vinculado ao usuário

endereco

string

opcional

telefone

string

opcional

celular

string

opcional

ativo

boolean

opcional

Ativa ou inativa o usuário no sistema

Padrão:

true

acesso_restrito

boolean

opcional

Parâmetros Bodyapplication/json

object {0}

Exemplo

{
  "nome_completo": "Maria Joaquina Amaral Pereira Goes",
  "login": "joaquina",
  "cpf": "007.287.507-08",
  "rg": "56456533",
  "data_nascimento": "2020-09-15",
  "id_perfil": 1,
  "email": "mariajoaquina@gmail.com",
  "sexo": "F",
  "horario_permitido_inicio": "00:00:00",
  "horario_permitido_fim": "23:59:00",
  "estado_civil": "solteiro",
  "id_centro_custo": 4,
  "senha_expira": true,
  "id_corretor": 12
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://demo.corbee.com.br/api/v2/users?nome_completo&login&cpf&rg&orgao_emissor&email&data_nascimento&id_perfil&id_centro_custo&dias_utilizacao_semana=1,2,3,4,5,6,7&horario_permitido_inicio=00:00:00&horario_permitido_fim=23:59:59&id_loja&sexo&estado_civil&atende_telemarketing&gerente_corretores&acessa_area_gerentes&salario&ajuda_custo&fuso_horario_agenda&senha_expira&visivel_corretores&ramal_pabx&utiliza_mfa&id_corretor&endereco&telefone&celular&ativo&acesso_restrito' \
--header 'Content-Type: application/json' \
--data-raw '{
    "nome_completo": "Maria Joaquina Amaral Pereira Goes",
    "login": "joaquina",
    "cpf": "007.287.507-08",
    "rg": "56456533",
    "data_nascimento": "2020-09-15",
    "id_perfil": 1,
    "email": "mariajoaquina@gmail.com",
    "sexo": "F",
    "horario_permitido_inicio": "00:00:00",
    "horario_permitido_fim": "23:59:00",
    "estado_civil": "solteiro",
    "id_centro_custo": 4,
    "senha_expira": true,
    "id_corretor": 12
}'

Respostas

🟢200Success

application/json

Body

object {0}

Exemplo

{}

Página anterior

Detalhes do Perfil

Próxima página

Atualização de usuário