Skip to main content
Skip table of contents

[POST] Criar ou atualizar usuários de filas de impressão

Este endpoint cria ou atualiza usuários de filas de impressão.

Caso não exista nenhum usuário com o mesmo Logon e Domain, um novo usuário será criado. Se já houver um usuário cadastrado com o mesmo Logon e Domain, mas com informações diferentes de Name e/ou Email, o usuário será atualizado.

Chamada

POST /v1/users

Cabeçalho (header)

Parâmetro

Descrição

Tipo

Obrigatório

Tenant

Nome do provedor.

Para obter essa informação, acesse a documentação: Menus do portal.

string

Sim

Authorization

Token de autenticação obtido.

string

Sim

Corpo (body)

Parâmetro

Descrição

Tipo

Obrigatório

Client

Nome do cliente, conforme cadastrado no portal NDD Orbix.

string

Sim

Users

Lista de usuários.

array

Sim

Logon

Identificação de acesso do usuário.

Não utilize acentos, símbolos e espaços.

string

Sim

Domain

Domínio ao qual o usuário pertence.

Não utilize acentos, símbolos e espaços.

string

Sim

Name

Nome completo do usuário.

string

Não

Email

E-mail do usuário.

Exemplo: abc@abc.com.

string

Não

Exemplo de requisição

Criar ou atualizar três usuários:

CODE
curl -L -X POST 'https://developer.nddorbix.com/printqueue-external-integration-api/v1/users' \
-H 'Tenant: {tenant}' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "Client": "ABC",
    "Users": [
        {
            "Logon": "carlos.silva",
            "Domain": "NDD",
            "Name": "Carlos Silva",
            "Email": "carlos.silva@ndd.tech"
        },
        {
            "Logon": "joao.souza",
            "Domain": "NDD",
            "Name": "João Souza"
        },
        {
            "Logon": "maria.oliveira",
            "Domain": "NDD",
            "Email": "maria.oliveira@ndd.tech"
        }
    ]
}'

Em uma mesma requisição, é possível criar ou atualizar até 4.500 usuários.

Para a criação ou atualização de mais de 4.500 usuários, realize mais de uma requisição.

Exemplo de resposta

A resposta de código 201 indica que:

  • todos os usuários foram criados ou atualizados com sucesso e retornará o seguinte JSON:

CODE
[]

ou

  • houve falha parcial na criação ou atualização de alguns usuários, e retornará, em JSON, o motivo da falha:

CODE
[
    {
        "user": "NDD//carlos silva",
        "errorMessage": "Logon is not valid."
    },
    {
        "user": "N D D//joao.souza",
        "errorMessage": "Domain is not valid."
    }
]

A resposta de código 400 indica que houve falha na criação ou atualização de todos os usuários, e retornará o seguinte JSON:

CODE
{
    "errors": {
        "3400": [
            "All users are invalid."
        ]
    },
    "title": "BadRequest",
    "status": 400,
    "detail": "BusinessException",
    "instance": "/v1/users"
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.