{
"info": {
"_postman_id": "9cdd228c-0ddb-4f2c-ac79-dc4f1bddba14",
"name": "Simplix - Documentação",
"description": "Documentação para utilização dos serviços de **Captura de Contrato** da Simplix\n\n### Resposta padronizada\n\nTodos os métodos da API possuem um corpo de resposta padronizado\n\n```\n{\n \"timeProcess\": 0,\n \"success\": true,\n \"message\": \"\",\n \"requestId: \"\",\n \"objectReturn\": {}\n}\n\n ```\n\n| **Nome** | **Tipo** | **Nulável** | **Descrição** |\n| --- | --- | --- | --- |\n| **timeProcess** | _Integer_ | Não | Tempo em milisegundos de duração do processamento |\n| **success** | _Boolen_ | Não | Resultado da consulta. |\n| **message** | _String_ | Sim | Mensagem de exception |\n| **requestId** | String | Nãp | uuid para identificação da request |\n| **objectReturn** | _Variavel_ | Sim | Objeto de domínio do método requisitado |\n\n### Testes Mínimos\n\nPara garantir o correto funcionamento e a conformidade das configurações tanto do lado da Simplix quanto do parceiro que está realizando a integração, é imprescindível evidenciar e enviar os cenários abaixo.\n\n1\\. Proposta PAGA\n\n2\\. Proposta CANCELADA\n\n3\\. Proposta com reapresentação de dados bancários e correção aplicada.\n\nSolicitamos que encaminhem as informações para o e-mail [contato@simplix.com.br](https://null), incluindo os respectivos números das propostas para cada cenário listado.\n\nCaso ainda não tenha CPFs de homologação ou os disponíveis estejam sem saldo, solicite uma nova listagem pelo e-mail: [contato@simplix.com.br.](https://null)\n\n### Ambiente de Homologação\n\nEndereço de homologação: [https://simplix-integration-dev.partner1.com.br/swagger/index.html](https://simplix-integration-dev.partner1.com.br/swagger/index.html)\n\nAs credenciais devem ser solicitadas pelo e-mail: [contato@simplix.com.br.](https://null)\n\n### Ambiente de Produção\n\nOs acessos de produção devem ser solicitados pelo e-mail [contato@simplix.com.br](https://mailto:contato@simplix.com.br), acompanhados das evidências dos testes mínimos. Sem a devida comprovação dos testes, as credenciais não serão liberadas.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "48822523",
"_collection_link": "https://tiago-lealssilva-3802060.postman.co/workspace/Tiago-Leal's-Workspace~6ce4030e-9f57-4e00-8ef0-c80f5e20fec5/collection/48822523-9cdd228c-0ddb-4f2c-ac79-dc4f1bddba14?action=share&source=collection_link&creator=48822523"
},
"item": [
{
"name": "AUTENTICAÇÃO",
"item": [
{
"name": "/api/Login",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"\",\n \"password\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/Login",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"Login"
]
},
"description": "Rota para obter o **Bearer Token.**\n\n### **Request**\n\n| **Nome** | **Tipo** | **Nulável** | **Descrição** |\n| --- | --- | --- | --- |\n| **username** | _String_ | Não | Usuário fornecido para autenticação |\n| **password** | _String_ | Não | Senha fornecida para autenticação |\n\n### **Response**\n\n| **Nome** | **Tipo** | **Nulável** | **Descrição** |\n| --- | --- | --- | --- |\n| **access_token** | _String_ | Não | Token JWT para autenticação |\n| **token_type** | _String_ | Não | Tipo de token |\n| **expires_in** | _Inteiro_ | Não | Tempo de validade do token |"
},
"response": [
{
"name": "Success",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"\",\n \"password\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/Login",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"Login"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"timeProcess\": \"\",\n \"requestId\": \"\",\n \"objectReturn\": {\n \"expires_in\": \"\",\n \"access_token\": \"\",\n \"token_type\": \"\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"\",\n \"password\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/Login",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"Login"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"in51\": {},\n \"in_f06\": {}\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"\",\n \"password\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/Login",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"Login"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"in51\": {},\n \"in_f06\": {}\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"\",\n \"password\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/Login",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"Login"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"timeProcess\": \"\",\n \"requestId\": \"\",\n \"objectReturn\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}"
},
{
"name": "Server Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"\",\n \"password\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/Login",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"Login"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"timeProcess\": \"\",\n \"requestId\": \"\",\n \"objectReturn\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}"
}
]
}
],
"description": "Método para obter o Bearer Token usando as credenciais de usuário e senha disponibilizadas pelo nosso canal de implantação.\n\nO Bearer Token gerado terá uma validade de 30 minutos e será utilizado para autenticar as demais requisições aos serviços.",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"requests": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"requests": {},
"exec": [
""
]
}
}
]
},
{
"name": "RELATÓRIOS",
"item": [
{
"name": "Commission",
"item": [
{
"name": "Daily",
"item": [
{
"name": "/api/Commission/List",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/Commission/List",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"Commission",
"List"
]
}
},
"response": [
{
"name": "Success",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/Commission/List",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"Commission",
"List"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"timeProcess\": \"\",\n \"requestId\": \"\",\n \"objectReturn\": {\n \"cpf\": \"\",\n \"taxa\": \"\",\n \"prazo\": \"\",\n \"corban\": \"\",\n \"produto\": \"\",\n \"usuario\": \"\",\n \"convenio\": \"\",\n \"proposta\": \"\",\n \"tabelaId\": \"\",\n \"propostaId\": \"\",\n \"dataHoraPago\": \"\",\n \"tabelaCodigo\": \"\",\n \"valorComissao\": \"\",\n \"valorProposta\": \"\",\n \"statusComissao\": \"\",\n \"statusproposta\": \"\",\n \"tabelaDescricao\": \"\",\n \"dataHoraDigitacao\": \"\",\n \"valorBaseComissao\": \"\",\n \"percentualComissao\": \"\"\n }\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/Commission/List",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"Commission",
"List"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"timeProcess\": \"\",\n \"requestId\": \"\",\n \"objectReturn\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}"
},
{
"name": "Server Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/Commission/List",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"Commission",
"List"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"timeProcess\": \"\",\n \"requestId\": \"\",\n \"objectReturn\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}"
}
]
}
],
"description": "Método para consultar as comissões lançadas em um dia específico.\n\n### **Request**\n\n| **Nome** | **Tipo** | **Nulável** | **Descrição** |\n| --- | --- | --- | --- |\n| **data** | _Date_ | Não | Data preferencial para consulta dos lançamentos. |\n\n### **Response**\n\n| **Nome** | **Tipo** | **Nulável** | **Descrição** |\n| --- | --- | --- | --- |\n| **cpf** | _String_ | Não | CPF do cliente. |\n| **taxa** | _Double_ | Não | Taxa de juros da proposta. |\n| **prazo** | _Integer_ | Não | Prazo da proposta. |\n| **corban** | _String_ | Não | Corban da proposta. |\n| **produto** | _String_ | Não | Produto da proposta. |\n| **usuario** | _String_ | Não | Usuário digitador da proposta. |\n| **convenio** | _String_ | Não | Convênio da proposta. |\n| **tabelaId** | _Integer_ | Não | ID da tabela da proposta. |\n| **propostaId** | _Integer_ | Não | ID Simplix da proposta. |\n| **dataHoraPago** | _Datetime_ | Não | Data/Hora do pagamento da proposta. |\n| **tabelaCodigo** | _String_ | Não | Código da tabela da proposta. |\n| **valorComissao** | _Double_ | Não | Valor da comissão. |\n| **valorProposta** | _Double_ | Não | Valor da proposta. |\n| **statusComissao** | _String_ | Não | Descrição do status da comissão (vide códigos em [Enumerables](https://documenter.getpostman.com/view/5019586/2sAY517zVk#16b80f55-6726-434a-9fda-9e3e892b271d).) |\n| **statusProposta** | _String_ | Não | Descrição do status da proposta (vide códigos em [Enumerables](https://documenter.getpostman.com/view/5019586/2sAY517zVk#16b80f55-6726-434a-9fda-9e3e892b271d).) |\n| **tabelaDescricao** | _String_ | Não | Nome da tabela da proposta. |\n| **dataHoraDigitacao** | _Datetime_ | Não | Data/Hora da digitação |\n| **valorBaseComissao** | _Double_ | Não | Valor para cálculo da comissão. |\n| **percentualComissao** | _Double_ | Não | Percentual de comissão. |"
}
],
"description": "Métodos disponíveis para realizar consulta das comissões."
}
]
},
{
"name": "GESTÃO DE USUÁRIOS",
"item": [
{
"name": "User",
"item": [
{
"name": "User",
"item": [
{
"name": "/api/User/:userId",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/User/:userId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"User",
":userId"
],
"variable": [
{
"key": "userId",
"value": "",
"description": "(Required) "
}
]
}
},
"response": [
{
"name": "Success",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"url": {
"raw": "{{baseUrl}}/api/User/:userId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"User",
":userId"
],
"variable": [
{
"key": "userId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"usuarioId\": \"\",\n \"login\": \"\",\n \"nome\": \"\",\n \"ativo\": \"\",\n \"profiles\": [\n {\n \"perfilId\": \"\",\n \"nome\": \"\"\n },\n {\n \"perfilId\": \"\",\n \"nome\": \"\"\n }\n ],\n \"cpf\": \"\",\n \"entidadeId\": \"\",\n \"bloqueado\": \"\"\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"url": {
"raw": "{{baseUrl}}/api/User/:userId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"User",
":userId"
],
"variable": [
{
"key": "userId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"timeProcess\": \"\",\n \"requestId\": \"\",\n \"objectReturn\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"url": {
"raw": "{{baseUrl}}/api/User/:userId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"User",
":userId"
],
"variable": [
{
"key": "userId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"timeProcess\": \"\",\n \"requestId\": \"\",\n \"objectReturn\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}"
},
{
"name": "Server Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"url": {
"raw": "{{baseUrl}}/api/User/:userId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"User",
":userId"
],
"variable": [
{
"key": "userId"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"timeProcess\": \"\",\n \"requestId\": \"\",\n \"objectReturn\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}"
}
]
}
],
"description": "API para obter os dados de um usuário específico.\n\n### **Response**\n\n| **Nome** | **Tipo** | **Nulável** | **Descrição** |\n| --- | --- | --- | --- |\n| **usuarioId** | _Integer_ | Não | ID do usuário |\n| **nome** | _String_ | Não | Nome do usuário |\n| **bloqueado** | _Boolean_ | Não | Indica se o usuário está bloqueado. |\n| **cpf** | _String_ | Não | CPF do usuário |\n| **entidadeId** | _Integer_ | Não | ID da empresa à qual o usuário pertence. |\n| **entidade** | _String_ | Não | Nome da empresa à qual o usuário pertence. |\n| **login** | _String_ | Não | Login utilizado pelo usuário para acessar o sistema. |\n| **ativo** | _String_ | Não | A = Ativo / E = Excluído |\n| **profiles.perfilId** | _Integer_ | Não | ID do perfil. |\n| **profiles.nome** | _String_ | Não | Descrição do perfil. |"
},
{
"name": "Save",
"item": [
{
"name": "/api/User/save",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"cpf\": \"\",\n \"entidadeId\": \"\",\n \"nome\": \"\",\n \"profiles\": [\n {\n \"perfilId\": \"\"\n }\n ],\n \"usuarioId\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/User/save",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"User",
"save"
]
}
},
"response": [
{
"name": "Success",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"cpf\": \"\",\n \"entidadeId\": \"\",\n \"nome\": \"\",\n \"profiles\": [\n {\n \"perfilId\": \"\"\n }\n ],\n \"usuarioId\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/User/save",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"User",
"save"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"timeProcess\": \"\",\n \"requestId\": \"\",\n \"objectReturn\": {\n \"profiles\": [\n {\n \"perfilId\": \"\"\n }\n ],\n \"usuarioId\": \"\",\n \"cpf\": \"\",\n \"entidadeId\": \"\",\n \"login\": \"\",\n \"senha\": \"\"\n }\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"cpf\": \"\",\n \"entidadeId\": \"\",\n \"descricao\": \"\",\n \"login\": \"\",\n \"senha\": \"\",\n \"profiles\": [\n {\n \"perfilId\": \"\"\n },\n {\n \"perfilId\": \"\"\n }\n ],\n \"usuarioId\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/User/save",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"User",
"save"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"timeProcess\": \"\",\n \"requestId\": \"\",\n \"objectReturn\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"cpf\": \"\",\n \"entidadeId\": \"\",\n \"descricao\": \"\",\n \"login\": \"\",\n \"senha\": \"\",\n \"profiles\": [\n {\n \"perfilId\": \"\"\n },\n {\n \"perfilId\": \"\"\n }\n ],\n \"usuarioId\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/User/save",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"User",
"save"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"timeProcess\": \"\",\n \"requestId\": \"\",\n \"objectReturn\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}"
},
{
"name": "Server Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"cpf\": \"\",\n \"entidadeId\": \"\",\n \"descricao\": \"\",\n \"login\": \"\",\n \"senha\": \"\",\n \"profiles\": [\n {\n \"perfilId\": \"\"\n },\n {\n \"perfilId\": \"\"\n }\n ],\n \"usuarioId\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/User/save",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"User",
"save"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"timeProcess\": \"\",\n \"requestId\": \"\",\n \"objectReturn\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}"
}
]
}
],
"description": "API para criação e edição de usuários.\n\nQuando o campo `usuarioId` for enviado como `null`, o sistema criará um novo usuário. Caso um `usuarioId` válido seja informado, o sistema realizará a edição dos dados do usuário correspondente.\n\n### **Request**\n\n| **Nome** | **Tipo** | **Nulável** | **Descrição** |\n| --- | --- | --- | --- |\n| **cpf** | _String_ | Não | CPF do usuário: Deve conter apenas números (sem pontos ou traços). Este campo é utilizado exclusivamente na criação de um novo usuário. Caso seja enviado em uma requisição de edição, o sistema irá ignorá-lo. |\n| **entidadeId** | _Integer_ | Não | Código da empresa (obter o seu código junto ao suporte) |\n| **profiles.perfilId** | _Integer_ | Não | ID do Perfil – IDs disponíveis na API: [Profiles](https://documenter.getpostman.com/view/5019586/2sAY517zVk#3adbd264-7074-4099-a56b-9d215e658964). |\n| **usuarioId** | _Integer_ | Sim | ID do usuário a ser editado. Para criar um novo usuário, envie null. |"
},
{
"name": "Reset",
"item": [
{
"name": "/api/User/reset/:userId",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/User/reset/:userId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"User",
"reset",
":userId"
],
"variable": [
{
"key": "userId",
"value": "",
"description": "(Required) "
}
]
}
},
"response": [
{
"name": "Success",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"url": {
"raw": "{{baseUrl}}/api/User/reset/:userId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"User",
"reset",
":userId"
],
"variable": [
{
"key": "userId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"timeProcess\": \"\",\n \"requestId\": \"\",\n \"objectReturn\": {\n \"newPassword\": \"\"\n }\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"url": {
"raw": "{{baseUrl}}/api/User/reset/:userId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"User",
"reset",
":userId"
],
"variable": [
{
"key": "userId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"timeProcess\": \"\",\n \"requestId\": \"\",\n \"objectReturn\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"url": {
"raw": "{{baseUrl}}/api/User/reset/:userId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"User",
"reset",
":userId"
],
"variable": [
{
"key": "userId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"timeProcess\": \"\",\n \"requestId\": \"\",\n \"objectReturn\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"url": {
"raw": "{{baseUrl}}/api/User/reset/:userId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"User",
"reset",
":userId"
],
"variable": [
{
"key": "userId"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"timeProcess\": \"\",\n \"requestId\": \"\",\n \"objectReturn\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}"
},
{
"name": "Server Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"url": {
"raw": "{{baseUrl}}/api/User/reset/:userId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"User",
"reset",
":userId"
],
"variable": [
{
"key": "userId"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"timeProcess\": \"\",\n \"requestId\": \"\",\n \"objectReturn\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}"
}
]
}
],
"description": "API para redefinição de senha do usuário.\n\n### **Response**\n\n| **Nome** | **Tipo** | **Nulável** | **Descrição** |\n| --- | --- | --- | --- |\n| **newPassword** | _String_ | Não | Senha gerada automaticamente pelo sistema. |"
},
{
"name": "List Users",
"item": [
{
"name": "/api/User/list-users",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/User/list-users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"User",
"list-users"
]
}
},
"response": [
{
"name": "Success",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer ",
"description": "Added as a part of security scheme: bearer"
}
],
"url": {
"raw": "{{baseUrl}}/api/User/list-users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"User",
"list-users"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"timeProcess\": \"\",\n \"requestId\": \"\",\n \"objectReturn\": [\n {\n \"usuarioId\": \"\",\n \"usuarioincluiId\": \"\",\n \"dataHoraInclui\": \"\",\n \"usuarioeditaId\": \"\",\n \"dataHoraEdita\": \"\",\n \"operacaoId\": \"\",\n \"grupoId\": \"\",\n \"descricao\": \"\",\n \"login\": \"\",\n \"senha\": \"\",\n \"grantType\": \"\",\n \"user\": \"\",\n \"userAccessIntegration\": \"\",\n \"passwordAccessIntegration\": \"\",\n \"password\": \"\",\n \"profiles\": [\n {\n \"perfilId\": \"\",\n \"descricao\": \"\",\n \"descricaoPerfil\": \"\",\n \"operationId\": \"\",\n \"operacao\": {\n \"operacaoId\": \"\",\n \"descricao\": \"\",\n \"sla\": \"\",\n \"config\": {},\n \"actions\": [\n {\n \"idAcao\": \"\",\n \"idOperacao\": \"\",\n \"idStatus\": \"