Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Índice
outlinetrue

Usuários (Users

Centros de Custo (Cost Centers)


Serviço utilizado para cadastrar . alterar e remover usuários e alterar centros de custo do Ahgora PontoWeb.


Aviso

Permitido envio em lote, máximo 1000 registros por requisição, ou 1mb (mega)


Usuários (users)

Item

Descrição

Fluxo:Cliente → PontoWeb
Rotahttps://api.ahgora.com.br/
users
costcenter
Método:POST
Usuários - Users
Centros de Custo - Cost Centers
CampoTipoObrig.Descrição
Regra
codigo
email
StringSim
E-mail do UsuárioCampo chave
Código do Centro de Custo
nomeStringSimNome do
UsuárioperfilStringSimNome do perfil a ser atribuído ao usuárioperfilNovoString*SimNome do perfil novo a ser atribuído ao usuário*Opcional, enviar somente quando deseja trocar o perfil do usuário, informando neste campo o novo perfil a ser atribuído.localizacaoArrayLocalização vinculada ao usuárioremoverString*SimCampo para remover o Usuário*Adicione o parâmetro REMOVER para remover o usuário
O campo também pode ser enviado em brancologin_samlString*SimNome de usuário para o SSO*Obrigatório para quem usa SSO
Centro de Custo


Exemplos de Requisições (Requests)


Corpo da Requisição - Inclusão e Alteração:

Bloco de código
languagetext
themeEmacs
linenumberstrue
collapsetrue
[
   {
      "emailcodigo": "[email protected]00000001",
    "perfil": "Administrador",
    "localizacao": [
      "Human Resources","Fabrica1"
    ],
    "login_saml": "[email protected]",
        "nome": "John DoeRH"
   }
]

Corpo da Requisição - Alteração Perfil:

Bloco de código
languagetext
themeEmacs
linenumberstrue
collapsetrue
[
  {
    "email": "[email protected]",
    "perfil": "Administrador",
    "localizacao": [
      "Human Resources"
    ],
    "login_saml": "[email protected]",
    "nome": "John Doe",
    "perfilNovo": "Apontador"
  }
]

Corpo da Requisição - Exclusão:

Bloco de código
languagetext
themeEmacs
linenumberstrue
collapsetrue
[
  {
    "email": "[email protected]",
    "perfil": "Administrador",
    "localizacao": [
      "Human Resources"
    ],
    "login_saml": "[email protected]",
    "nome": "John Doe",
    "remover": "REMOVER"
  ,
  {
    "codigo": "00000002",
    "nome": "ADM"
  }
]


Exemplos de Respostas (Responses)


Resposta quando SUCESSO - Code 200:

Bloco de código
languagetext
themeEmacs
linenumberstrue
collapsetrue
{
   "company": "a000101",
   "unique": "bd751350",
  "subunique": "c01de0cc",
  "message": "User´sCost center's Integration on progress"
}
Dica

Para obter mais detalhe, utilize o serviço Process. Para saber mais entre no link.


ERRO de Validação - Code 400:

Bloco de código
languagetext
themeEmacs
linenumberstrue
collapsetrue
{
  "error": {
    "message": "Request format must be an Array",
    "code": 400
  }
}


ERRO de Autenticação - Code 401:

Bloco de código
languagetext
themeEmacs
linenumberstrue
collapsetrue
{
  "companymessage": "a000101Unauthorized",
  "unique": "bd751350",
  "subuniquecode": 401
}


ERRO de Permissão - Code 403:

Bloco de código
languagetext
themeEmacs
linenumberstrue
collapsetrue
{
    "error": {
        "message": "c01de0ccForbidden",
        "messagecode": "User´s403
  Integration on progress"}
}

Observação: Verificar as permissões do usuário para acessar a rota/serviço.