1 de 5

Gestão de usuários

Aqui estão documentadas todas as nossas APIs públicas relacionadas à gestão de usuários

Criar usuário

O objetivo dessa API é automatizar a criação de usuários no sistema a partir de uma requisição do tipo REST.

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/users/create

Headers

Name

Type

Description

Request Body

Name

Type

Description

{
    "userId": 50111289,
    "login": "INTEGRACAO.INTEGRACOES2",
    "name": "USUÁRIO CRIADO VIA INTEGRAÇÃO 2",
    "redirectUrl": null
}

// CPF repetido ou usuário repetidos
Já existe um usuário com esse login

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Exemplo de Requisição:

{ 
      "name": "USUÁRIO CRIADO VIA INTEGRAÇÃO 2",
      "nickName": "INTEGRAÇÃO",
      "cpfNumber": "38251883024",
      "email": ["email@email.com.br"], 
      "phone": ["11911112222"],
      "nationality": "Brasileiro", 
      "sex": "M",
      "address": "Rua Domingos de Moraes", 
      "addressComplement": "AP 21", 
      "addressNumber": 1000, 
      "neighborhood": "Vila Mariana", 
      "postalCode": "04150100", 
      "city": "São Paulo", 
      "idState": "SP",
      "birthday": "30/11/1990", 
      "cnpj": ["73386365000170"], 
      "login": "INTEGRACAO.INTEGRACOES3", 
      "password": "VIANUVEM", 
      "profiles": [12312]
}

Consultar usuário

O objetivo dessa API é automatizar a consulta de usuários no sistema a partir de uma requisição do tipo REST.

GET https://webservices.vianuvem.com.br/AdminVianuvem/api/users/byCPF/{cpf}

Um “route parameter” é enviado com o CPF do usuário a ser consultado.

Headers

Name

Type

Description

{
    "name": "USUÁRIO CRIADO VIA INTEGRAÇÃO",
    "birthday": "30/11/1990",
    "sex": "M",
    "nickName": "INTEGRAÇÃO",
    "nationality": "Brasileiro",
    "cpfNumber": "18594015038",
    "email": [
        "email@email.com.br"
    ],
    "phone": [
        "null(11) 911112222"
    ],
    "login": "INTEGRACAO.INTEGRACOES",
    "postalCode": "04150100",
    "address": "Rua Domingos de Moraes",
    "addressNumber": "1000",
    "addressComplement": "AP 21",
    "neighborhood": "Vila Mariana",
    "idState": "SP",
    "city": "São Paulo",
    "profiles": [
        50029246,
        50030051
    ],
    "cnpj": [
        "73386365000170",
        "30092328000146"
    ]
}

Usuário não encontrado

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Desativar usuário

O objetivo dessa API é automatizar a desativação de usuários no sistema a partir de uma requisição do tipo REST.

DELETE https://webservices.vianuvem.com.br/AdminVianuvem/api/users/{login}/byLogin

Um “route parameter” é enviado com o nome do usuário a ser desativado.

Headers

Name

Type

Description

{
    "returnedValue": true,
    "returnedMessage": "SUCESSO"
}

ERROR

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Ativar usuário

O objetivo dessa API é automatizar a ativação de usuários no sistema a partir de uma requisição do tipo REST.

PUT https://webservices.vianuvem.com.br/AdminVianuvem/api/users{login)/byLogin

Um “route parameter” é enviado com o nome do usuário a ser ativado.

Headers

Name

Type

Description

{
    "returnedValue": true,
    "returnedMessage": "SUCESSO"
}

ERROR

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Criar usuário

O objetivo dessa API é automatizar a criação de usuários no sistema a partir de uma requisição do tipo REST.

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/users/create

Headers

Name

Type

Description

Request Body

Name

Type

Description

{
    "userId": 50111289,
    "login": "INTEGRACAO.INTEGRACOES2",
    "name": "USUÁRIO CRIADO VIA INTEGRAÇÃO 2",
    "redirectUrl": null
}

// CPF repetido ou usuário repetidos
Já existe um usuário com esse login

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Exemplo de Requisição:

{ 
      "name": "USUÁRIO CRIADO VIA INTEGRAÇÃO 2",
      "nickName": "INTEGRAÇÃO",
      "cpfNumber": "38251883024",
      "email": ["email@email.com.br"], 
      "phone": ["11911112222"],
      "nationality": "Brasileiro", 
      "sex": "M",
      "address": "Rua Domingos de Moraes", 
      "addressComplement": "AP 21", 
      "addressNumber": 1000, 
      "neighborhood": "Vila Mariana", 
      "postalCode": "04150100", 
      "city": "São Paulo", 
      "idState": "SP",
      "birthday": "30/11/1990", 
      "cnpj": ["73386365000170"], 
      "login": "INTEGRACAO.INTEGRACOES3", 
      "password": "VIANUVEM", 
      "profiles": [12312]
}

Consultar usuário

O objetivo dessa API é automatizar a consulta de usuários no sistema a partir de uma requisição do tipo REST.

GET https://webservices.vianuvem.com.br/AdminVianuvem/api/users/byCPF/{cpf}

Um “route parameter” é enviado com o CPF do usuário a ser consultado.

Headers

Name

Type

Description

{
    "name": "USUÁRIO CRIADO VIA INTEGRAÇÃO",
    "birthday": "30/11/1990",
    "sex": "M",
    "nickName": "INTEGRAÇÃO",
    "nationality": "Brasileiro",
    "cpfNumber": "18594015038",
    "email": [
        "email@email.com.br"
    ],
    "phone": [
        "null(11) 911112222"
    ],
    "login": "INTEGRACAO.INTEGRACOES",
    "postalCode": "04150100",
    "address": "Rua Domingos de Moraes",
    "addressNumber": "1000",
    "addressComplement": "AP 21",
    "neighborhood": "Vila Mariana",
    "idState": "SP",
    "city": "São Paulo",
    "profiles": [
        50029246,
        50030051
    ],
    "cnpj": [
        "73386365000170",
        "30092328000146"
    ]
}

Usuário não encontrado

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>