openapi: 3.0.0 info: title: mka version: 1.0.0 paths: /api/: get: summary: Basic Auth operationId: >- c_users_pedrofilho_documents_bruno_mk-auth_api_autentica_o_basic_auth_yml description: >- Utilizando o metodo de autenticaçao **Basic Auth** para gerar o token **JWT** passando o **Cliente_id** e **Client_Secret** Solicite ao servidor que gere um token por meio de uma chamada GET. **`Para gerar o token, é obrigatório o uso do protocolo HTTPS.`** tags: - Autenticação responses: '200': description: '' security: - basic_auth: [] /api/caixa/editar: put: summary: Editar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_caixa_editar_yml description: >- #### Endpoint: api/caixa/editar ##### Método: PUT **Descrição**: Edita um registro de movimento do caixa. | _**Campo**_ | _**Limite/Tipo**_ | | --- | --- | | `tipo` | entrada / saida | | `valor` | 12,2 / DECIMAL | | `historico` | 255 caracteres | | `uuid` | 48 caracteres | | _**Observação**_ | | --- | | **Tipo**: Defina o movimento do caixa como **entrada** ou **saida**, especificando o tipo de movimentação. | | **valor**: Especifica o valor da transação | | **historico**: Descreve detalhes adicionais sobre a transação, fornecendo um motivo para a operação. | | **uuid**: Identificação do movimento do caixa a ser editado. | tags: - Caixa responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string dados: type: object properties: tipo: type: string valor: type: number historico: type: string uuid: type: string example: status: sucesso mensagem: Movimento no caixa editado com sucesso dados: tipo: entrada valor: 190 historico: Recebimento do titulo 397 / lise uuid: 2d99ba81-a671-11ee-9c16-080027c29949 parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/editar' /api/caixa/inserir: post: summary: Inserir operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_caixa_inserir_yml description: >- #### Endpoint: api/caixa/inserir ##### Método: POST **Descrição**: Insere um novo movimento no caixa. | _**Campo**_ | _**Limite/Tipo**_ | | --- | --- | | `tipo` | entrada / saida | | `valor` | 12,2 / DECIMAL | | `historico` | 255 caracteres | | _**Observação**_ | | --- | | **Tipo**: Defina o movimento do caixa como **entrada** ou **saida**, especificando o tipo de movimentação. | | **valor**: Especifica o valor da transação | | **historico**: Descreve detalhes adicionais sobre a transação, fornecendo um motivo para a operação. | tags: - Caixa responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string dados: type: object properties: tipo: type: string valor: type: number historico: type: string example: status: sucesso mensagem: Movimento no caixa inserido com sucesso dados: tipo: saida valor: 1670.78 historico: Bônus por horas extras para a funcionária Lise. parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/inserir' /api/caixa/listar/pagina=1: get: summary: Listar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_caixa_listar_yml description: >- #### Endpoint: api/caixa/listar ##### Método: GET **Descrição**: Esse endpoint retorna o movimento do caixa no formato JSON. **Paginação** A paginação é iniciada na página 1 por padrão. Para navegar entre os registros, o total de páginas é incluído no corpo da resposta, auxiliando na navegação. | Parâmetros de consulta | Descrição | Exemplo | | --- | --- | --- | | `pagina:` | Paginação para navegar entre os registros.(pagina padrão 1). | /listar/pagina=2 | | `limite:` | Quantidade de registros que serão retornados (limite maximo 500 padrão) _parâmetro opcional_ | /listar/pagina=9&limite=150 | **Filtro para consulta** Este endpoint aceita parâmetros para filtrar os resultados. Após api/caixa/listar, adicione uma barra **`/`** e os parâmetros desejados. | Observação | Exemplo | | --- | --- | | Todos os parâmetros retornados na resposta **"caixa":** deste endpoint podem ser utilizados para filtrar os resultados da consulta, separando-os com **`&`**. | listar/usuario=admin&entrada=170 | tags: - Caixa responses: '200': description: '' content: application/json: schema: type: object properties: total_registros: type: number consulta_atual: type: number pagina_atual: type: number total_paginas: type: number caixa: type: array items: type: string properties: '0': type: object properties: uuid: type: string historico: type: string entrada: type: object saida: type: string data: type: string tipomov: type: string id: type: string '1': type: object properties: uuid: type: string historico: type: string entrada: type: string saida: type: object data: type: string tipomov: type: string id: type: string '2': type: object properties: uuid: type: string historico: type: string entrada: type: string saida: type: string data: type: string tipomov: type: string id: type: string '3': type: object properties: uuid: type: string historico: type: string entrada: type: string saida: type: object data: type: string tipomov: type: string id: type: string '4': type: object properties: uuid: type: string historico: type: string entrada: type: string saida: type: object data: type: string tipomov: type: string id: type: string '5': type: object properties: uuid: type: string historico: type: string entrada: type: string saida: type: object data: type: string tipomov: type: string id: type: string '6': type: object properties: uuid: type: string historico: type: string entrada: type: string saida: type: string data: type: string tipomov: type: string id: type: string '7': type: object properties: uuid: type: string historico: type: string entrada: type: string saida: type: object data: type: string tipomov: type: string id: type: string '8': type: object properties: uuid: type: string historico: type: string entrada: type: string saida: type: object data: type: string tipomov: type: string id: type: string example: total_registros: 49 consulta_atual: 9 pagina_atual: 3 total_paginas: 3 caixa: - uuid: 71dda811-b0be-11ee-9b54-080027c29949 historico: Titulo 662 estornado via API / mary entrada: null saida: '77.99' data: '2024-01-11 15:17:32' tipomov: aut id: '343' - uuid: b58e2247-b0bf-11ee-9b54-080027c29949 historico: 'Recebimento do titulo 693 via API / jose ' entrada: '170.00' saida: null data: '2024-01-11 15:26:35' tipomov: aut id: '344' - uuid: 62DC6DDA-4FE3-42BF-830A-8AF16435BC14 historico: Titulo 692 estornado entrada: '0.00' saida: '110.00' data: '2024-01-11 16:34:41' tipomov: aut id: '345' - uuid: 1890a4b6-b475-11ee-9ded-080027c29949 historico: 'Recebimento do titulo 720 via API / lise ' entrada: '111.50' saida: null data: '2024-01-16 08:42:34' tipomov: aut id: '347' - uuid: 2752b846-b475-11ee-9ded-080027c29949 historico: 'Recebimento do titulo 721 via API / lise ' entrada: '77.00' saida: null data: '2024-01-16 08:42:58' tipomov: aut id: '348' - uuid: 09696cbf-b476-11ee-9ded-080027c29949 historico: 'Recebimento do titulo 725 via API / jose ' entrada: '120.00' saida: null data: '2024-01-16 08:49:18' tipomov: aut id: '349' - uuid: F7A47BA6-8240-4606-98EC-A508BF6B2556 historico: Recebimento do titulo 726 / jose entrada: '120.00' saida: '0.00' data: '2024-01-16 10:55:21' tipomov: aut id: '350' - uuid: bb286dde-b57c-11ee-9b24-080027c29949 historico: 'Recebimento do titulo 718 via API / leti ' entrada: '120.00' saida: null data: '2024-01-17 16:09:44' tipomov: aut id: '352' - uuid: edc6891e-b57c-11ee-9b24-080027c29949 historico: 'Recebimento do titulo 716 via API / Seth ' entrada: '145.00' saida: null data: '2024-01-17 16:11:09' tipomov: aut id: '353' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/caixa/2fb571b4-a4bb-11ee-9bc4-080027c29949: delete: summary: Remover operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_caixa_remover_yml description: >- ### Endpoint: api/caixa/{uuid do caixa} #### Método: DELETE **Descrição**: Deleta um movimento específico do caixa passando o UUID no parâmetro da URL. tags: - Caixa responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Registro excluido com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/caixa/show/0C208B3B-F6E3-4135-AD05-CAF166B858B2: get: summary: Show operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_caixa_show_yml description: >- #### Endpoint: api/caixa/show/{uuid do caixa} ##### Método: GET **Descrição**: Retorna os detalhes de um movimento específico do caixa em formato JSON, passando o UUID como parâmetro na URL. tags: - Caixa responses: '200': description: '200' content: application/json: schema: type: object properties: id: type: string uuid_caixa: type: string usuario: type: string data: type: string historico: type: string complemento: type: string entrada: type: string saida: type: string tipomov: type: string planodecontas: type: string example: id: '15' uuid_caixa: 0C208B3B-F6E3-4135-AD05-CAF166B858B2 usuario: admin data: '2023-08-11 07:43:44' historico: Recebimento do titulo 132 / mary complemento: '' entrada: '70.00' saida: '0.00' tipomov: aut planodecontas: Outros parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/cliente/editar: put: summary: Editar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_cliente_editar_yml description: >- ## Editar Informações do Cliente Este endpoint permite atualizar os detalhes de um cliente existente no sistema. Ao enviar uma solicitação PUT para `http://{{IP_MK-AUTH}}/api/cliente/editar`, você pode modificar as informações do cliente com base no payload fornecido. Todos os campos da tabela sis_cliente podem ser alterados, menos login, id e uuid_cliente. ### Exemplo da requisição para alterar o nome O corpo da requisição deve conter os seguintes parâmetros: - **nome** (string): O nome do cliente que você deseja atualizar. - **uuid** (string): O identificador único do cliente cujas informações estão sendo editadas. ### Resultado Esperado Em caso de uma requisição bem-sucedida, as informações do cliente serão atualizadas no banco de dados. A resposta geralmente incluirá uma confirmação da atualização ou mensagens de status relevantes. Este endpoint permite atualizar os detalhes de um cliente existente no sistema. Ao enviar uma solicitação PUT para a URL especificada, você pode modificar as informações do cliente com base nos parâmetros fornecidos. #### Parâmetros da Requisição O corpo da requisição deve estar no formato JSON e incluir os seguintes parâmetros: - **nome** (string): O nome completo do cliente. Este é um campo obrigatório. - **uuid** (string): Um identificador único para o cliente. É usado para especificar qual cliente terá suas informações atualizadas e também é um campo obrigatório. #### Exemplo de Corpo da Requisição ``` json { "nome": "Francisco Pedro da Costa Filho", "uuid": "35F9F3A5-50CE-4BB8-B53C-E8BAAD..." } ``` #### Estrutura da Resposta Em caso de uma requisição bem-sucedida, o servidor responderá com uma confirmação da atualização. A resposta geralmente inclui: - **status** (string): Indica o sucesso ou falha da operação. - **message** (string): Fornece informações adicionais sobre o processo de atualização. #### Exemplo de Resposta ``` json { "status": "success", "message": "Informações do cliente atualizadas com sucesso." } ``` Certifique-se de substituir os placeholders na requisição por valores reais para garantir o funcionamento correto da API. tags: - Cliente responses: '200': description: '' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/editar' /api/cliente/inserir: post: summary: Inserir operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_cliente_inserir_yml description: >- #### Endpoint: api/cliente/inserir ##### Método: POST **Descrição**: Envia o cadastro para conclusão no **WebAdmin**. | **Campo** _**/**_ `Observação` | _**Limite/Valor**_ | | --- | --- | | `nome`: Nome completo do cliente **\[campo obrigatório: sim\]** | 255 caracteres | | `Login`: Login do usuário. **\[campo obrigatório: sim\]** | 64 caracteres | | `senha`: Senha de acesso do cliente **\[campo obrigatório: sim\]** | 32 caracteres | | `email`: Endereço de e-mail para o envio de faturas, avisos, etc. | 255 caracteres | | `cpf`**:** CPF ou CNPJ com ou sem pontuação **\[campo obrigatório: sim\]** | 20 caracteres | | `rg`: Rg do cliente com ou sem pontuação | 255 caracteres | | `data_nasc`: Data de nascimento no formato dd/mm/aaaa. | 20 caracteres | | `endereco`: Endereço do cliente. | 255 caracteres | | `bairro`: Bairro do cliente. | 255 caracteres | | `numero`: Número do endereço. | 20 caracteres | | `complemento`: Informações adicionais para o endereço. | 255 caracteres | | `cep`: CEP do cliente. | 20 caracteres | | `cidade`: Cidade do cliente. | 255 caracteres | | `estado`: Estado do cliente. | 10 caracteres | | `telefone`: Número de telefone do cliente. | 255 caracteres | | `celular`: Número de celular do cliente. | 50 caracteres | tags: - Cliente responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string dados: type: object properties: nome: type: string login: type: string senha: type: string email: type: string cpf: type: string rg: type: string data_nasc: type: string endereco: type: string bairro: type: string numero: type: string complemento: type: string cep: type: string cidade: type: string estado: type: string telefone: type: string celular: type: string example: status: sucesso dados: nome: Elisa Caroline Gonçalves login: elisa senha: '123' email: elisacarolinegoncalves@outloock.com.br cpf: 455.717.141-90 rg: 37.783.633-3 data_nasc: 27/02/1947 endereco: Rua Pêssego bairro: Morada do Sol numero: '404' complemento: Casa amarela cep: 69901-067 cidade: Rio Branco estado: AC telefone: (68) 3635-4277 celular: (68) 98181-4242 parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/inserir' /api/cliente/listar/pagina=1: get: summary: Listar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_cliente_listar_yml description: >- #### Endpoint: api/cliente/listar ##### Método: GET **Descrição**: Retorna uma lista de clientes no formato JSON. **Paginação** A paginação é iniciada na página 1 por padrão. Para navegar entre os registros, o total de páginas é incluído no corpo da resposta, auxiliando na navegação. | Parâmetros de consulta | Descrição | Exemplo | | --- | --- | --- | | `pagina:` | Paginação para navegar entre os registros.(pagina padrão 1). | /listar/pagina=2 | | `limite:` | Quantidade de registros que serão retornados (limite maximo 500 padrão) _parâmetro opcional_ | /listar/pagina=9&limite=150 | **Filtro para consulta** Este endpoint aceita parâmetros para filtrar os resultados. Após api/cliente/listar, adicione uma barra **`/`** e os parâmetros desejados. | Observação | Exemplo | | --- | --- | | Todos os parâmetros retornados na resposta **"clientes":** deste endpoint podem ser utilizados para filtrar os resultados da consulta, separando-os com **`&`**. | listar/login=ada&ramal=todos | tags: - Cliente responses: '200': description: '' content: application/json: schema: type: object properties: total_registros: type: number consulta_atual: type: number pagina_atual: type: number total_paginas: type: number clientes: type: array items: type: string properties: '0': type: object properties: uuid: type: string id: type: string codigo: type: object nome: type: string nome_res: type: string login: type: string cpf_cnpj: type: string tipo: type: string coordenadas: type: string senha: type: string email: type: string ip: type: object mac: type: object ramal: type: string endereco: type: string numero: type: string bairro: type: string complemento: type: string cidade: type: string estado: type: string cep: type: string '1': type: object properties: uuid: type: string id: type: string codigo: type: string nome: type: string nome_res: type: string login: type: string cpf_cnpj: type: string tipo: type: string coordenadas: type: string senha: type: string email: type: string ip: type: string mac: type: string ramal: type: string endereco: type: string numero: type: string bairro: type: string complemento: type: string cidade: type: string estado: type: string cep: type: string '2': type: object properties: uuid: type: string id: type: string codigo: type: string nome: type: string nome_res: type: string login: type: string cpf_cnpj: type: string tipo: type: string coordenadas: type: string senha: type: string email: type: string ip: type: object mac: type: object ramal: type: string endereco: type: string numero: type: string bairro: type: string complemento: type: string cidade: type: string estado: type: string cep: type: string '3': type: object properties: uuid: type: string id: type: string codigo: type: string nome: type: string nome_res: type: string login: type: string cpf_cnpj: type: string tipo: type: string coordenadas: type: string senha: type: string email: type: string ip: type: object mac: type: object ramal: type: string endereco: type: string numero: type: string bairro: type: string complemento: type: string cidade: type: string estado: type: string cep: type: string example: total_registros: 4 consulta_atual: 4 pagina_atual: 1 total_paginas: 1 clientes: - uuid: AA30401D-7675-4986-95CB-1D86C61B198E id: '1' codigo: null nome: Lise Meitner nome_res: Lise login: lise cpf_cnpj: '48096657000120' tipo: pppoe coordenadas: '-3.9820893,-38.4407801' senha: '123' email: lisemei@gmail.com ip: null mac: null ramal: todos endereco: Rua Doutor Zamenhof numero: '404' bairro: Cocó complemento: de 301/302 ao fim cidade: Fortaleza estado: CE cep: '60192280' - uuid: 1E998938-B473-4527-B933-B3C4AA97198C id: '2' codigo: b6f2aa33e43b8 nome: Jose de Sousa Santos nome_res: jose login: jose cpf_cnpj: '47226118661' tipo: pppoe coordenadas: '-10.836162, -63.343491' senha: essaeasenhaconfia email: josetesteapi@gmail.com ip: 192.168.0.1 mac: 2A:7B:4F:9E:C1:8E ramal: todos endereco: Quadra 2 Conjunto 2 numero: '344' bairro: Setor Leste (Vila Estrutural - Guará) complemento: Casa Amarela cidade: Brasília estado: DF cep: 71261-110 - uuid: AB3B6BAC-480E-4E32-8503-4FCC72A26BB9 id: '11' codigo: 615ecf2c2b7bd nome: Ada Lovelace nome_res: Ada login: ada cpf_cnpj: '71978536000124' tipo: pppoe coordenadas: '-3.732355,-38.4734847' senha: '123' email: adalace@gmail.com ip: null mac: null ramal: todos endereco: Rua José Carlos Gurgel Nogueira numero: '404' bairro: Vicente Pinzon complemento: até 209/210 cidade: Fortaleza estado: CE cep: '686577777' - uuid: B285CE6E-107F-4A9C-8414-583178EC9CD8 id: '12' codigo: e5b6285526f99 nome: Letícia Cristiane da Mata nome_res: Letícia Cristiane da Mata login: leti cpf_cnpj: '93929332230' tipo: pppoe coordenadas: '-9.1508586,-70.6209447' senha: '123' email: leticia_cristiane_damata@securitycontrol.com.br ip: null mac: null ramal: todos endereco: Avenida Paraná numero: '404' bairro: Centro complemento: '296' cidade: Acrelândia estado: AC cep: 69945-970 parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/cliente/58A89344-9EF1-4792-8BAE-A367613D91E8: delete: summary: Remover operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_cliente_remover_yml description: >- #### Endpoint: api/cliente/{uuid do cliente} ##### Método: DELETE **Descrição**: Deleta um cliente do sistema passando o UUID no parâmetro da URL. tags: - Cliente responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Registro excluido com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/cliente/show/fco.pedro: get: summary: Show operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_cliente_show_yml description: >- #### Endpoint: api/cliente/show/{login} #### Endpoint: api/cliente/show/{uuid do cliente} ##### Método: GET **Descrição**: Retorna os detalhes de um cliente específico em formato JSON. tags: - Cliente responses: '200': description: '200' content: application/json: schema: type: object properties: id: type: string nome: type: string email: type: string endereco: type: string bairro: type: string cidade: type: string cep: type: string estado: type: string cpf_cnpj: type: string fone: type: object obs: type: string nascimento: type: string estado_civil: type: string cadastro: type: string login: type: string tipo: type: string night: type: string aviso: type: string foto: type: string venc: type: string mac: type: object complemento: type: string ip: type: object ramal: type: string rg: type: string isento: type: string celular: type: string bloqueado: type: string autoip: type: string automac: type: string conta: type: string ipvsix: type: object plano: type: string send: type: string cli_ativado: type: string simultaneo: type: string turbo: type: string comodato: type: string observacao: type: string chavetipo: type: string chave: type: object contrato: type: string ssid: type: string senha: type: string numero: type: string responsavel: type: object nome_pai: type: object nome_mae: type: object expedicao_rg: type: string naturalidade: type: object acessacen: type: string pessoa: type: string endereco_res: type: string numero_res: type: string bairro_res: type: string cidade_res: type: string cep_res: type: string estado_res: type: string complemento_res: type: string desconto: type: string acrescimo: type: string equipamento: type: string vendedor: type: string nextel: type: object accesslist: type: string resumo: type: string grupo: type: string codigo: type: object prilanc: type: string tipobloq: type: string adesao: type: string mbdisco: type: string sms: type: string ltrafego: type: string planodown: type: string ligoudown: type: string statusdown: type: string statusturbo: type: string opcelular: type: string nome_res: type: string coordenadas: type: string rem_obs: type: string valor_sva: type: string dias_corte: type: string user_ip: type: string user_mac: type: string data_ip: type: string data_mac: type: string last_update: type: string data_bloq: type: object tags: type: string tecnico: type: string data_ins: type: string altsenha: type: string geranfe: type: string mesref: type: string ipfall: type: string tit_abertos: type: string parc_abertas: type: string tipo_pessoa: type: string celular2: type: object mac_serial: type: object status_corte: type: string plano15: type: string pgaviso: type: string porta_olt: type: object caixa_herm: type: object porta_splitter: type: object onu_ont: type: object switch: type: object tit_vencidos: type: string pgcorte: type: string interface: type: object login_atend: type: string cidade_ibge: type: string estado_ibge: type: object data_desbloq: type: string pool_name: type: string pool6: type: string rec_email: type: string termo: type: string opcelular2: type: string dot_ref: type: object tipo_cliente: type: string armario_olt: type: string conta_cartao: type: string plano_bloqc: type: string uuid_cliente: type: string data_desativacao: type: object tipo_cob: type: string fortunus: type: string gsici: type: string local_dici: type: string example: id: '1' nome: Lise Meitner email: lisemei@gmail.com endereco: Rua Doutor Zamenhof bairro: Cocó cidade: Fortaleza cep: '60192280' estado: CE cpf_cnpj: '48096657000120' fone: null obs: '' nascimento: '1997-01-17' estado_civil: S cadastro: 18/01/2023 login: lise tipo: pppoe night: nao aviso: '[""]' foto: X17fa0249d0f24_van-gogh-paisagem-st-remy-d.jpg venc: '05' mac: null complemento: de 301/302 ao fim ip: null ramal: todos rg: '7676767' isento: nao celular: '0919758282' bloqueado: nao autoip: nao automac: nao conta: '3' ipvsix: null plano: 215Mbps_Fibra send: nao cli_ativado: s simultaneo: nao turbo: nenhum comodato: sim observacao: nao chavetipo: nenhuma chave: null contrato: FE1A6C51 ssid: outros senha: '123' numero: '404' responsavel: null nome_pai: null nome_mae: null expedicao_rg: '1997-01-17' naturalidade: null acessacen: sim pessoa: fisica endereco_res: Rua Doutor Zamenhof numero_res: '404' bairro_res: Cocó cidade_res: Fortaleza cep_res: '60192280' estado_res: CE complemento_res: de 301/302 ao fim desconto: '0.00' acrescimo: '0.00' equipamento: 'Equipamento ' vendedor: nenhum nextel: null accesslist: nao resumo: '102023' grupo: remessa codigo: null prilanc: tot tipobloq: aut adesao: '0.00' mbdisco: '0' sms: sim ltrafego: '0' planodown: nenhum ligoudown: '012011' statusdown: 'off' statusturbo: 'off' opcelular: nenhuma nome_res: Lise coordenadas: '-3.9820893,-38.4407801' rem_obs: '2023-08-22 00:00:00' valor_sva: '0.00' dias_corte: '15' user_ip: admin user_mac: admin data_ip: '2023-08-21 14:24:03' data_mac: '2023-01-18 12:46:17' last_update: '2023-11-06 18:38:00' data_bloq: null tags: todos tecnico: nenhum data_ins: '2023-01-18 12:46:17' altsenha: sim geranfe: sim mesref: ant ipfall: 192.168.0.1 tit_abertos: '7' parc_abertas: '7' tipo_pessoa: '3' celular2: null mac_serial: null status_corte: full plano15: nenhum pgaviso: sim porta_olt: null caixa_herm: null porta_splitter: null onu_ont: null switch: null tit_vencidos: '0' pgcorte: sim interface: null login_atend: full_users cidade_ibge: '2304400' estado_ibge: null data_desbloq: '2023-09-04 16:20:03' pool_name: nenhum pool6: 2001:db8:1:5::/64 rec_email: sim termo: 1C/2023 opcelular2: nenhuma dot_ref: null tipo_cliente: '3' armario_olt: '1' conta_cartao: '0' plano_bloqc: nenhum uuid_cliente: AA30401D-7675-4986-95CB-1D86C61B198E data_desativacao: null tipo_cob: titulo fortunus: '0' gsici: '1' local_dici: u parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/chamado/editar: put: summary: Editar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_chamado_editar_yml description: >- #### Endpoint: api/chamado/editar ##### Método: PUT **Descrição**: Este endpoint permite a edição de um chamado no sistema. | _**Campo**_ | _**Limite/Valor**_ | | --- | --- | | `assunto` | 255 caracteres | | `prioridade` | 20 caracteres | | `chamado` | 255 caracteres | | _**Observação**_ | | --- | | **assunto**: Os **campos abaixo** são importantes para garantir uma boa consulta. É uma boa prática mantê-los, mas eles podem ser personalizados para atender às necessidades específicas.
**\[Financeiro, Dúvidas, Conexão, Cadastro, Crítica, Sugestão, Transferencia, Cancelamento, Outros.\]** | | **prioridade**: Definição das prioridades para os chamados no sistema.
**\[baixa, normal, alta\]** | | **chamado**: Número do chamado a ser editado. | tags: - Chamado responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string dados: type: object properties: assunto: type: string prioridade: type: string chamado: type: string example: status: sucesso mensagem: Chamado editado com sucesso dados: assunto: Conexão prioridade: alta chamado: '29122313564327' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/editar' /api/chamado/fechar: put: summary: Fechar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_chamado_fechar_yml description: >- #### Endpoint: api/chamado/fechar ##### Método: PUT **Descrição**: Este endpoint possibilita o fechamento de um chamado no sistema. | _**Campo**_ | _**Limite/Valor**_ | | --- | --- | | `motivo` | LONGTEXT | | `chamado` | 255 caracteres | | _**Observação**_ | | --- | | **motivo**: Seja claro e específico no motivo. Isso ajuda a manter informações úteis para futuras referências e melhoria constante nos serviços de suporte. | | **chamado**: Número do chamado a ser fechado. | tags: - Chamado responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string dados: type: object properties: motivo: type: string chamado: type: string example: status: sucesso mensagem: Chamado fechado com sucesso dados: motivo: >- Após a análise do incidente relatado, identificamos e corrigimos a instabilidade na conexão. chamado: '29122313564327' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/fechar' /api/chamado/inserir: post: summary: Inserir operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_chamado_inserir_yml description: >- #### Endpoint: api/chamado/inserir ##### Método: POST **Descrição**: Insere um novo chamado no sistema. | _**Campo**_ | _**Limite/Valor**_ | | --- | --- | | `login` | 255 caracteres | | `nome` | 255 caracteres | | `email` | 255 caracteres | | `assunto` | 255 caracteres | | `prioridade` | 20 caracteres | | _**Observação**_ | | --- | | **login**: Login do usuário campo **Obrigatório**(O chamado está vinculado ao login do cliente). | | **nome**: Não é obrigatório. | | **email**: Não é obrigatório. | | **assunto**: Os **campos abaixo** são importantes para garantir uma boa consulta. É uma boa prática mantê-los, mas eles podem ser personalizados para atender às necessidades específicas.
**\[Financeiro, Dúvidas, Conexão, Cadastro, Crítica, Sugestão, Transferencia, Cancelamento, Outros.\]** | | **prioridade**: Definição das prioridades para os chamados no sistema.
**\[baixa, normal, alta\]** | tags: - Chamado responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string chamado: type: string dados: type: object properties: login: type: string nome: type: string email: type: string assunto: type: string prioridade: type: string example: status: sucesso mensagem: Chamado criado com sucesso chamado: '29122313564327' dados: login: lise nome: Lise Meitner email: liseteste.api@gmail.com assunto: Dúvidas prioridade: normal parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/inserir' /api/chamado/listar/pagina=1: get: summary: Listar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_chamado_listar_yml description: >- #### Endpoint: api/chamado/listar ##### Método: GET **Descrição**: Esse endpoint retorna os chamados em formato JSON. **Paginação** A paginação é iniciada na página 1 por padrão. Para navegar entre os registros, o total de páginas é incluído no corpo da resposta, auxiliando na navegação. | Parâmetros de consulta | Descrição | Exemplo | | --- | --- | --- | | `pagina:` | Paginação para navegar entre os registros.(pagina padrão 1). | /listar/pagina=2 | | `limite:` | Quantidade de registros que serão retornados (limite maximo 500 padrão) _parâmetro opcional_ | /listar/pagina=9&limite=150 | **Filtro para consulta** Este endpoint aceita parâmetros para filtrar os resultados. Após api/chamado/listar, adicione uma barra **`/`** e os parâmetros desejados. | Observação | Exemplo | | --- | --- | | Todos os parâmetros retornados na resposta **"chamados":** deste endpoint podem ser utilizados para filtrar os resultados da consulta, separando-os com **`&`**. | listar/status=aberto | tags: - Chamado responses: '200': description: '' content: application/json: schema: type: object properties: total_registros: type: number consulta_atual: type: number pagina_atual: type: number total_paginas: type: number chamados: type: array items: type: string properties: '0': type: object properties: uuid: type: string id: type: string abertura: type: string login: type: string prioridade: type: string chamado: type: string status: type: string assunto: type: string '1': type: object properties: uuid: type: string id: type: string abertura: type: string login: type: string prioridade: type: string chamado: type: string status: type: string assunto: type: string '2': type: object properties: uuid: type: string id: type: string abertura: type: string login: type: string prioridade: type: string chamado: type: string status: type: string assunto: type: string '3': type: object properties: uuid: type: string id: type: string abertura: type: string login: type: string prioridade: type: string chamado: type: string status: type: string assunto: type: string example: total_registros: 4 consulta_atual: 4 pagina_atual: 1 total_paginas: 1 chamados: - uuid: f7cf0665-a4bf-11ee-9bc4-080027c29949 id: '99' abertura: '2023-12-27 09:58:13' login: lise prioridade: alta chamado: '27122309581324' status: aberto assunto: Conexão - uuid: 01HKCNJ3KT8621VVNAW83YNH5Z id: '102' abertura: '2024-01-05 09:19:01' login: lise prioridade: normal chamado: '05012409182851' status: aberto assunto: Outros - uuid: 01HND2KDPEVEJB76C6TXXA2HQF id: '109' abertura: '2024-01-30 08:38:19' login: jose prioridade: normal chamado: '30012408380559' status: aberto assunto: Crítica - uuid: 01HND2NN9GFJ6EKAKSV63M9BDE id: '110' abertura: '2024-01-30 08:39:33' login: ada prioridade: normal chamado: '30012408385097' status: aberto assunto: Sugestão parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/chamado/reabrir/12122313374476: get: summary: Reabrir operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_chamado_reabrir_yml description: >- #### Endpoint: api/chamado/reabrir ##### Método: GET **Descrição**: Este endpoint permite a reabertura de um chamado no sistema, passando o número do chamado na URL. tags: - Chamado responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Chamado reaberto com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/chamado/20122310060932: delete: summary: Remover operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_chamado_remover_yml description: >- #### Endpoint: api/chamado/{número do chamado} ##### Método: DELETE **Descrição**: Excluir o chamado do sistema ao passando o número do chamado na URL. tags: - Chamado responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Registro excluido com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/chamado/show/13122315245479: get: summary: Show operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_chamado_show_yml description: >- #### Endpoint: api/chamado/show/{número do chamado} ##### Método: GET **Descrição**: Retorna os detalhes de um chamado específico em formato JSON. tags: - Chamado responses: '200': description: '200' content: application/json: schema: type: object properties: id: type: string uuid_suporte: type: string assunto: type: string abertura: type: string fechamento: type: string email: type: string status: type: string chamado: type: string nome: type: string login: type: string atendente: type: string visita: type: string prioridade: type: string ramal: type: string reply: type: string tecnico: type: object login_atend: type: string motivo_fechar: type: string example: id: '99' uuid_suporte: f7cf0665-a4bf-11ee-9bc4-080027c29949 assunto: Conexão abertura: '2023-12-27 09:58:13' fechamento: '2023-12-27 09:59:52' email: liseteste.api@gmail.com status: fechado chamado: '27122309581324' nome: Lise Meitner login: lise atendente: API visita: '2024-01-01 00:00:00' prioridade: alta ramal: todos reply: nao tecnico: null login_atend: full_users motivo_fechar: >- Após a análise do incidente relatado, identificamos e corrigimos a instabilidade na conexão. parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/conta/editar: put: summary: Editar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_conta_editar_yml description: >- #### Endpoint: api/conta/editar #### Método: PUT **Descrição**: Este endpoint permite a alteração de uma conta no sistema. A tabela de armazenamento é `sis_boleto`, que gerencia informações relacionadas a contas bancárias e configurações de boleto. O endpoint segue o padrão de API RESTful para MK-Auth API. - **Endpoint Base**: `/api/conta/editar` - **Método**: PUT - **Autenticação**: Requer token JWT no header `Authorization: Bearer {TokenJWT}` (gerado via autenticação Basic Auth, conforme descrito na seção de Autenticação da coleção). - **Descrição**: Insere um novo registro de conta na tabela `sis_boleto`. Campos obrigatórios incluem `utilizar`, `banco`, e `nome`. Outros campos são opcionais e seguem os defaults da tabela. - **Observações**: - Validações: O campo `utilizar` deve ser com valores: apiboleto, boleto, fatura e cartao. - Resposta de Sucesso: Retorna o ID ou UUID do novo registro de conta criado. ## Cabeçalhos (Headers) - `Authorization`: Bearer {TokenJWT} (obrigatório para autenticação). - `Content-Type`: application/json (para o corpo da requisição). ## Parâmetros do Corpo O corpo da requisição deve ser um objeto JSON com os campos baseados na tabela `sis_boleto`. Campos obrigatórios estão marcados com \*. | Campo | Tipo/Limite | Descrição | Obrigatório | Default/Exemplo | | --- | --- | --- | --- | --- | | uuid | varchar(64) | Código uuid. | Sim\* | | | utilizar | varchar(10) | Identificador entre apiboleto, boleto, fatura e cartao. | Sim\* | "boleto" | | banco | varchar(200) | Nome do banco. | Sim\* | "Banco do Brasil" | | nome | varchar(50) | Nome descritivo da conta. | Sim\* | "Conta Corrente" | | codigo_cedente | text | Código do cedente. | Não | NULL | | agencia | text | Número da agência. | Não | "1234" | | ag_digito | text | Dígito da agência. | Não | "X" | | conta | text | Número da conta bancária. | Não | "12345" | | ct_digito | text | Dígito da conta. | Não | "0" | | carteira | text | Código da carteira. | Não | "21" | | convenio | text | Código do convênio. | Não | NULL | | cedente | text | Nome do cedente. | Não | "Empresa XYZ" | | contrato | text | Número do contrato. | Não | NULL | | obs_linha1 | text | Observação linha 1 do boleto. | Não | NULL | | obs_linha2 | text | Observação linha 2 do boleto. | Não | NULL | | obs_linha3 | text | Observação linha 3 do boleto. | Não | NULL | | obs_linha4 | text | Observação linha 4 do boleto. | Não | NULL | | instr_linha1 | text | Instrução linha 1 do boleto. | Não | NULL | | instr_linha2 | text | Instrução linha 2 do boleto. | Não | NULL | | instr_linha3 | text | Instrução linha 3 do boleto. | Não | NULL | | instr_linha4 | text | Instrução linha 4 do boleto. | Não | NULL | | instr_linha5 | text | Instrução linha 5 do boleto. | Não | NULL | | taxa | varchar(20) | Valor da taxa do boleto. | Não | NULL | | nosso | varchar(255) | Nosso número. | Não | NULL | | multa | varchar(20) | Valor da multa. | Não | NULL | | juros | varchar(20) | Valor dos juros. | Não | NULL | | codigo_cliente | varchar(255) | Código do cliente. | Não | NULL | | ponto_venda | varchar(255) | Ponto de venda. | Não | NULL | | nosso1 | varchar(3) | Parte 1 do nosso número. | Não | NULL | | nosso2 | varchar(3) | Parte 2 do nosso número. | Não | NULL | | nosso3 | varchar(9) | Parte 3 do nosso número. | Não | NULL | | constante1 | varchar(1) | Constante 1 do boleto. | Não | NULL | | constante2 | varchar(1) | Constante 2 do boleto. | Não | NULL | | byte | varchar(1) | Byte específico do boleto. | Não | NULL | | token | varchar(255) | Token de autenticação. | Não | NULL | | gateway | varchar(5) | Gateway de pagamento (ex: 'f2b'). | Não | 'f2b' | | pagseguro | varchar(255) | Token PagSeguro. | Não | NULL | | modalidade | varchar(2) | Modalidade do boleto. | Não | '02' | | paypalconta | varchar(255) | Conta PayPal. | Não | NULL | | diasatraso | int(11) | Dias de atraso permitidos. | Não | 90 | | layout | varchar(255) | Layout do boleto. | Não | 'detalhado' | | tipomm | varchar(4) | Tipo de multa/juros (ex: 'fixo'). | Não | 'fixo' | | logosva | varchar(3) | Exibir logo SVA. | Não | 'nao' | | instauto | varchar(3) | Instruções automáticas. | Não | 'sim' | | nossonumfinal | varchar(255) | Nosso número final. | Não | NULL | | tipo | varchar(255) | Tipo de conta. | Não | NULL | | variacao | varchar(5) | Variação da carteira. | Não | '-019' | | localpag | varchar(255) | Local de pagamento. | Não | 'ANTES DO VENCIMENTO EM TODOS OS BANCOS' | | titulo_inicial | int(11) | Título inicial. | Não | NULL | | avalista | varchar(255) | Nome do avalista. | Não | NULL | | desconto | decimal(12,2) | Valor do desconto. | Não | 0.00 | | tipodesc | enum('fixo','perc') | Tipo de desconto (fixo ou percentual). | Não | 'fixo' | | cpf_cnpj | varchar(50) | CPF ou CNPJ do cedente. | Não | NULL | | esp_doc | varchar(12) | Espécie do documento. | Não | NULL | | token_gnet | varchar(32) | Token Gerencianet. | Não | NULL | | varalfa | varchar(2) | Variação alfanumérica. | Não | 'aa' | | token_bcash | varchar(128) | Token BCash. | Não | NULL | | token_pagseguro | varchar(128) | Token PagSeguro. | Não | NULL | | calc_boleto | enum('sim','nao') | Calcular boleto automaticamente. | Não | 'sim' | | last_update | datetime | Data da última atualização. | Não | NULL | | referencia | enum('sim','nao') | Usar como referência. | Não | 'sim' | | transmissao | varchar(64) | Dados de transmissão. | Não | NULL | | layout_pdf | varchar(255) | Layout do PDF do boleto. | Não | 'pdf' | | complemento | varchar(2) | Complemento do boleto. | Não | '00' | | contra | enum('sim','nao') | Conta contra. | Não | 'nao' | | cnab | enum('240','400') | Formato CNAB (240 ou 400). | Não | '400' | | num_remessa | int(11) | Número da remessa. | Não | NULL | | id_conta_gnet | varchar(32) | ID da conta Gerencianet. | Não | NULL | | cliente_id_gnet | varchar(64) | ID do cliente Gerencianet. | Não | NULL | | cliente_secret_gnet | varchar(64) | Secret do cliente Gerencianet. | Não | NULL | | cliente_id_teste_gnet | varchar(64) | ID de teste do cliente Gerencianet. | Não | NULL | | cliente_secret_teste_gnet | varchar(64) | Secret de teste do cliente Gerencianet. | Não | NULL | | ocorrencia | varchar(128) | Dados de ocorrência. | Não | NULL | | codbanco | varchar(3) | Código do banco. | Não | NULL | | tipo_desc | enum('perc','fixo') | Tipo de desconto (percentual ou fixo). | Não | 'fixo' | ### Exemplo de Corpo JSON ``` json { "utilizar": "boleto", "banco": "Banco do Brasil", "nome": "Conta Corrente Principal", "agencia": "1234", "ag_digito": "X", "conta": "12345", "ct_digito": "0", "carteira": "21", "cedente": "Empresa XYZ", "desconto": 10.00, "tipodesc": "fixo", "calc_boleto": "sim", "referencia": "sim", "cnab": "400" } ``` ## Respostas Esperadas ### Sucesso (200 OK) - **Descrição**: Conta inserida com sucesso. - **Corpo JSON**: ``` json { "status": "sucesso", "mensagem": "Conta inserida com sucesso", "dados": { "id": 123, // ID gerado "utilizar": "conta1" } } ``` ## Exemplo de Requisição no Postman - **URL**: `https://{{IP_MK-AUTH}}/api/conta/inserir` (substitua `{{IP_MK-AUTH}}` pela URL do seu Mk-Auth). - **Método**: POST - **Headers**: - Authorization: Bearer {{TokenJWT}} ## Observações Adicionais - **Segurança**: Certifique-se de usar HTTPS para proteger dados sensíveis, como informações bancárias. tags: - Conta responses: '200': description: '' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: content: text/plain: schema: type: string /api/conta/inserir: post: summary: Inserir operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_conta_inserir_yml description: >- #### Endpoint: api/conta/inserir #### Método: POST **Descrição**: Este endpoint permite a inserção de uma nova conta no sistema. A tabela de armazenamento é `sis_boleto`, que gerencia informações relacionadas a contas bancárias e configurações de boleto. O endpoint segue o padrão de API RESTful para MK-Auth API. - **Endpoint Base**: `/api/conta/inserir` - **Método**: POST - **Autenticação**: Requer token JWT no header `Authorization: Bearer {TokenJWT}` (gerado via autenticação Basic Auth, conforme descrito na seção de Autenticação da coleção). - **Descrição**: Insere um novo registro de conta na tabela `sis_boleto`. Campos obrigatórios incluem `utilizar`, `banco`, e `nome`. Outros campos são opcionais e seguem os defaults da tabela. - **Observações**: - Validações: O campo `utilizar` deve ser com valores: apiboleto, boleto, fatura e cartao. - Resposta de Sucesso: Retorna o ID ou UUID do novo registro de conta criado. ## Cabeçalhos (Headers) - `Authorization`: Bearer {TokenJWT} (obrigatório para autenticação). - `Content-Type`: application/json (para o corpo da requisição). ## Parâmetros do Corpo O corpo da requisição deve ser um objeto JSON com os campos baseados na tabela `sis_boleto`. Campos obrigatórios estão marcados com \*. | Campo | Tipo/Limite | Descrição | Obrigatório | Default/Exemplo | | --- | --- | --- | --- | --- | | utilizar | varchar(10) | Identificador entre apiboleto, boleto, fatura e cartao. | Sim\* | "boleto" | | banco | varchar(200) | Nome do banco. | Sim\* | "Banco do Brasil" | | nome | varchar(50) | Nome descritivo da conta. | Sim\* | "Conta Corrente" | | codigo_cedente | text | Código do cedente. | Não | NULL | | agencia | text | Número da agência. | Não | "1234" | | ag_digito | text | Dígito da agência. | Não | "X" | | conta | text | Número da conta bancária. | Não | "12345" | | ct_digito | text | Dígito da conta. | Não | "0" | | carteira | text | Código da carteira. | Não | "21" | | convenio | text | Código do convênio. | Não | NULL | | cedente | text | Nome do cedente. | Não | "Empresa XYZ" | | contrato | text | Número do contrato. | Não | NULL | | obs_linha1 | text | Observação linha 1 do boleto. | Não | NULL | | obs_linha2 | text | Observação linha 2 do boleto. | Não | NULL | | obs_linha3 | text | Observação linha 3 do boleto. | Não | NULL | | obs_linha4 | text | Observação linha 4 do boleto. | Não | NULL | | instr_linha1 | text | Instrução linha 1 do boleto. | Não | NULL | | instr_linha2 | text | Instrução linha 2 do boleto. | Não | NULL | | instr_linha3 | text | Instrução linha 3 do boleto. | Não | NULL | | instr_linha4 | text | Instrução linha 4 do boleto. | Não | NULL | | instr_linha5 | text | Instrução linha 5 do boleto. | Não | NULL | | taxa | varchar(20) | Valor da taxa do boleto. | Não | NULL | | nosso | varchar(255) | Nosso número. | Não | NULL | | multa | varchar(20) | Valor da multa. | Não | NULL | | juros | varchar(20) | Valor dos juros. | Não | NULL | | codigo_cliente | varchar(255) | Código do cliente. | Não | NULL | | ponto_venda | varchar(255) | Ponto de venda. | Não | NULL | | nosso1 | varchar(3) | Parte 1 do nosso número. | Não | NULL | | nosso2 | varchar(3) | Parte 2 do nosso número. | Não | NULL | | nosso3 | varchar(9) | Parte 3 do nosso número. | Não | NULL | | constante1 | varchar(1) | Constante 1 do boleto. | Não | NULL | | constante2 | varchar(1) | Constante 2 do boleto. | Não | NULL | | byte | varchar(1) | Byte específico do boleto. | Não | NULL | | token | varchar(255) | Token de autenticação. | Não | NULL | | gateway | varchar(5) | Gateway de pagamento (ex: 'f2b'). | Não | 'f2b' | | pagseguro | varchar(255) | Token PagSeguro. | Não | NULL | | modalidade | varchar(2) | Modalidade do boleto. | Não | '02' | | paypalconta | varchar(255) | Conta PayPal. | Não | NULL | | diasatraso | int(11) | Dias de atraso permitidos. | Não | 90 | | layout | varchar(255) | Layout do boleto. | Não | 'detalhado' | | tipomm | varchar(4) | Tipo de multa/juros (ex: 'fixo'). | Não | 'fixo' | | logosva | varchar(3) | Exibir logo SVA. | Não | 'nao' | | instauto | varchar(3) | Instruções automáticas. | Não | 'sim' | | nossonumfinal | varchar(255) | Nosso número final. | Não | NULL | | tipo | varchar(255) | Tipo de conta. | Não | NULL | | variacao | varchar(5) | Variação da carteira. | Não | '-019' | | localpag | varchar(255) | Local de pagamento. | Não | 'ANTES DO VENCIMENTO EM TODOS OS BANCOS' | | titulo_inicial | int(11) | Título inicial. | Não | NULL | | avalista | varchar(255) | Nome do avalista. | Não | NULL | | desconto | decimal(12,2) | Valor do desconto. | Não | 0.00 | | tipodesc | enum('fixo','perc') | Tipo de desconto (fixo ou percentual). | Não | 'fixo' | | cpf_cnpj | varchar(50) | CPF ou CNPJ do cedente. | Não | NULL | | esp_doc | varchar(12) | Espécie do documento. | Não | NULL | | token_gnet | varchar(32) | Token Gerencianet. | Não | NULL | | varalfa | varchar(2) | Variação alfanumérica. | Não | 'aa' | | token_bcash | varchar(128) | Token BCash. | Não | NULL | | token_pagseguro | varchar(128) | Token PagSeguro. | Não | NULL | | calc_boleto | enum('sim','nao') | Calcular boleto automaticamente. | Não | 'sim' | | last_update | datetime | Data da última atualização. | Não | NULL | | referencia | enum('sim','nao') | Usar como referência. | Não | 'sim' | | transmissao | varchar(64) | Dados de transmissão. | Não | NULL | | layout_pdf | varchar(255) | Layout do PDF do boleto. | Não | 'pdf' | | complemento | varchar(2) | Complemento do boleto. | Não | '00' | | contra | enum('sim','nao') | Conta contra. | Não | 'nao' | | cnab | enum('240','400') | Formato CNAB (240 ou 400). | Não | '400' | | num_remessa | int(11) | Número da remessa. | Não | NULL | | id_conta_gnet | varchar(32) | ID da conta Gerencianet. | Não | NULL | | cliente_id_gnet | varchar(64) | ID do cliente Gerencianet. | Não | NULL | | cliente_secret_gnet | varchar(64) | Secret do cliente Gerencianet. | Não | NULL | | cliente_id_teste_gnet | varchar(64) | ID de teste do cliente Gerencianet. | Não | NULL | | cliente_secret_teste_gnet | varchar(64) | Secret de teste do cliente Gerencianet. | Não | NULL | | ocorrencia | varchar(128) | Dados de ocorrência. | Não | NULL | | codbanco | varchar(3) | Código do banco. | Não | NULL | | tipo_desc | enum('perc','fixo') | Tipo de desconto (percentual ou fixo). | Não | 'fixo' | ### Exemplo de Corpo JSON ``` json { "utilizar": "boleto", "banco": "Banco do Brasil", "nome": "Conta Corrente Principal", "agencia": "1234", "ag_digito": "X", "conta": "12345", "ct_digito": "0", "carteira": "21", "cedente": "Empresa XYZ", "desconto": 10.00, "tipodesc": "fixo", "calc_boleto": "sim", "referencia": "sim", "cnab": "400" } ``` ## Respostas Esperadas ### Sucesso (200 OK) - **Descrição**: Conta inserida com sucesso. - **Corpo JSON**: ``` json { "status": "sucesso", "mensagem": "Conta inserida com sucesso", "dados": { "id": 123, // ID gerado "utilizar": "conta1" } } ``` ## Exemplo de Requisição no Postman - **URL**: `https://{{IP_MK-AUTH}}/api/conta/inserir` (substitua `{{IP_MK-AUTH}}` pela URL do seu Mk-Auth). - **Método**: POST - **Headers**: - Authorization: Bearer {{TokenJWT}} ## Observações Adicionais - **Segurança**: Certifique-se de usar HTTPS para proteger dados sensíveis, como informações bancárias. tags: - Conta responses: '200': description: '' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: content: text/plain: schema: type: string /api/conta/listar/pagina=1: get: summary: Listar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_conta_listar_yml description: >- #### Endpoint: api/conta/listar ##### Método: GET **Descrição**: Retorna uma lista de contas no formato JSON. **Paginação** A paginação é iniciada na página 1 por padrão. Para navegar entre os registros, o total de páginas é incluído no corpo da resposta, auxiliando na navegação. | Parâmetros de consulta | Descrição | Exemplo | | --- | --- | --- | | `pagina:` | Paginação para navegar entre os registros.(pagina padrão 1). | /listar/pagina=2 | | `limite:` | Quantidade de registros que serão retornados (limite maximo 500 padrão) _parâmetro opcional_ | /listar/pagina=9&limite=150 | **Filtro para consulta** Este endpoint aceita parâmetros para filtrar os resultados. Após api/conta/listar, adicione uma barra **`/`** e os parâmetros desejados. | Observação | Exemplo | | --- | --- | | Todos os parâmetros retornados na resposta **"contas":** deste endpoint podem ser utilizados para filtrar os resultados da consulta, separando-os com **`&`**. | listar/agencia=3519 | tags: - Conta responses: '200': description: '' content: application/json: schema: type: object properties: total_registros: type: number consulta_atual: type: number pagina_atual: type: number total_paginas: type: number contas: type: array items: type: string properties: '0': type: object properties: id: type: string uuid: type: string banco: type: string agencia: type: string ag_digito: type: string conta: type: string ct_digito: type: string '1': type: object properties: id: type: string uuid: type: string banco: type: string agencia: type: string ag_digito: type: string conta: type: string ct_digito: type: string '2': type: object properties: id: type: string uuid: type: string banco: type: string agencia: type: string ag_digito: type: string conta: type: string ct_digito: type: string '3': type: object properties: id: type: string uuid: type: string banco: type: string agencia: type: string ag_digito: type: string conta: type: string ct_digito: type: string example: total_registros: 4 consulta_atual: 4 pagina_atual: 1 total_paginas: 1 contas: - id: '1' uuid: 64323B09-D14D-4698-8D79-AAF68ECB115A banco: proprio.php agencia: '' ag_digito: '' conta: '' ct_digito: '' - id: '3' uuid: 32709DFB-857D-4DB7-B9D4-BC11EBEDB9E2 banco: itau.php agencia: '7777' ag_digito: '' conta: '01443' ct_digito: '4' - id: '4' uuid: 7A052ECB-3E26-480C-95E4-38D4BF3E2F49 banco: iugu.php agencia: '' ag_digito: '' conta: '' ct_digito: '' - id: '7' uuid: 17D224E5-D88D-4A5D-B74A-5EFD282A31D6 banco: galaxpay.php agencia: '' ag_digito: '' conta: '' ct_digito: '' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/conta/E6DB3748-D868-4E16-9509-3221249B2257: delete: summary: Remover operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_conta_remover_yml description: >- #### Endpoint: api/conta/{uuid da conta} ##### Método: DELETE **Descrição**: Deleta uma conta específica passando o UUID no parâmetro da URL. tags: - Conta responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Registro excluido com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/conta/show/32709DFB-857D-4DB7-B9D4-BC11EBEDB9E2: get: summary: Show operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_conta_show_yml description: >- #### Endpoint: api/conta/show/{uuid da conta} ##### Método: GET **Descrição**: Retorna os detalhes de uma conta específica em formato JSON. tags: - Conta responses: '200': description: '200' content: application/json: schema: type: object properties: id: type: string uuid_boleto: type: string delconta: type: string utilizar: type: string banco: type: string codigo_cedente: type: string agencia: type: string ag_digito: type: string conta: type: string ct_digito: type: string carteira: type: string convenio: type: string cedente: type: string contrato: type: object obs_linha1: type: string obs_linha2: type: string obs_linha3: type: string obs_linha4: type: object instr_linha1: type: object instr_linha2: type: object instr_linha3: type: object instr_linha4: type: object instr_linha5: type: string taxa: type: string add_taxa: type: string nosso: type: object multa: type: string juros: type: string codigo_cliente: type: string ponto_venda: type: string nosso1: type: object nosso2: type: object nosso3: type: object constante1: type: object constante2: type: object byte: type: object token: type: object gateway: type: string pagseguro: type: object pagdigital: type: object modalidade: type: string paypalconta: type: object diasatraso: type: string layout: type: string logosva: type: string instauto: type: string nossonumfinal: type: object tipo: type: object variacao: type: string localpag: type: string titulo_inicial: type: string avalista: type: string desconto: type: string tipodesc: type: string cpf_cnpj: type: string esp_doc: type: string token_gnet: type: object nome: type: string varalfa: type: string token_bcash: type: object token_pagseguro: type: object calc_boleto: type: string last_update: type: string referencia: type: string transmissao: type: object layout_pdf: type: string layout_carne: type: string complemento: type: string contra: type: string cnab: type: string num_remessa: type: string id_conta_gnet: type: object cliente_id_gnet: type: string cliente_secret_gnet: type: string cliente_id_teste_gnet: type: object cliente_secret_teste_gnet: type: object ocorrencia: type: string codbanco: type: string tipo_desc: type: string transmissao240: type: object transmissao400: type: object url_gnet: type: object email_gnet: type: string token_juno: type: object token_sjuno: type: object email_juno: type: string dias_baixa: type: string galax_id: type: string galax_hash: type: string galax_tokenwebhook: type: object iugu_token: type: string iugu_url: type: object example: id: '3' uuid_boleto: 32709DFB-857D-4DB7-B9D4-BC11EBEDB9E2 delconta: 'n' utilizar: boleto banco: itau.php codigo_cedente: '' agencia: '9657' ag_digito: '' conta: '01443' ct_digito: '4' carteira: '177' convenio: '' cedente: Provedor de Internet ByteLink cedente contrato: null obs_linha1: >- Atenção: o pagamento deste boleto deve ser efetuado até a data de vencimento para evitar juros e multas. obs_linha2: >- Para pagamento via transferência bancária, utilize os dados abaixo: obs_linha3: >- Agradecemos pela sua preferência e confiança em nossos serviços! obs_linha4: null instr_linha1: null instr_linha2: null instr_linha3: null instr_linha4: null instr_linha5: >- Aguarde o processamento: Após efetuar o pagamento, aguarde até que o caixa confirme a transação e forneça um comprovante de pagamento. Guarde esse comprovante em local seguro para futuras referências. taxa: 5,00 add_taxa: 'n' nosso: null multa: '0.00' juros: '0.00' codigo_cliente: '' ponto_venda: '' nosso1: null nosso2: null nosso3: null constante1: null constante2: null byte: null token: null gateway: banco pagseguro: null pagdigital: null modalidade: '02' paypalconta: null diasatraso: '0' layout: detalhado_flecha_dourada_grade_padrao logosva: nao instauto: nao nossonumfinal: null tipo: null variacao: '-019' localpag: >- RECEBÍVEL EM AGÊNCIA BANCÁRIA, LOTÉRICAS OU APLICATIVO DE QUALQUER BANCO. titulo_inicial: '8888' avalista: Juliana Gomes Da Silva Alvez desconto: '0.00' tipodesc: fixo cpf_cnpj: '00012345678978' esp_doc: '10' token_gnet: null nome: Itau varalfa: aa token_bcash: null token_pagseguro: null calc_boleto: sim last_update: '2023-10-31 07:29:05' referencia: sim transmissao: null layout_pdf: detalhado_flecha_dourada_grade_padrao layout_carne: 3folhas_grade_nova complemento: '00' contra: nao cnab: '400' num_remessa: '11' id_conta_gnet: null cliente_id_gnet: '' cliente_secret_gnet: '' cliente_id_teste_gnet: null cliente_secret_teste_gnet: null ocorrencia: '06' codbanco: '341' tipo_desc: fixo transmissao240: null transmissao400: null url_gnet: null email_gnet: '0' token_juno: null token_sjuno: null email_juno: '0' dias_baixa: '29' galax_id: '' galax_hash: '' galax_tokenwebhook: null iugu_token: '' iugu_url: null parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/contato/editar: put: summary: Editar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_contato_editar_yml description: >- #### Endpoint: api/contato/editar ##### Método: PUT **Descrição**: Editar um contato passando o UUID no corpo da requisição. | _**Campo**_ | _**Limite/Valor**_ | | --- | --- | | `nome` | 255 caracteres | | `login` | 255 caracteres | | `numero` | 255 caracteres | | `email` | 255 caracteres | | `assunto` | 255 caracteres | | `msg` | LONGTEXT | | `uuid` | 48 caracteres | | _**Observação**_ | | --- | | **nome**: Nome completo do contato | | **login**: Login não é obrigatório, caso apenas queira enviar uma mensagem para o provedor. **\[campo obrigatório: não\]** | | **numero**: Número de contato do cliente | | **email**: Email de contato do cliente. | | **assunto**: Titulo do assunto
**EX**: Financeiro, Dúvidas, Conexão, Cadastro, Crítica, Sugestão, Outros. | | **msg**: O corpo da mensagem que será incluído no contato desempenha um papel crucial na comunicação eficaz. | | **uuid**: Do contato a ser editado. | tags: - Contato responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string dados: type: object properties: nome: type: string login: type: string numero: type: string email: type: string assunto: type: string msg: type: string uuid: type: string example: status: sucesso mensagem: Contato editado com sucesso dados: nome: Jose santos login: jose numero: (68) 98181-4242 email: apiemail@gmai.com assunto: Dúvidas sobre Plano msg: >- Gostaria de entender melhor quais são os serviços cobertos pelo meu plano. uuid: 6d19058a-a679-11ee-9c16-080027c29949 parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/editar' /api/contato/inserir: post: summary: Inserir operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_contato_inserir_yml description: >- #### Endpoint: api/contato/inserir ##### Método: POST **Descrição**: Insere um novo contato. | _**Campo**_ | _**Limite/Valor**_ | | --- | --- | | `nome` | 255 caracteres | | `login` | 255 caracteres | | `numero` | 255 caracteres | | `email` | 255 caracteres | | `assunto` | 255 caracteres | | `msg` | LONGTEXT | | _**Observação**_ | | --- | | **nome**: Nome completo do contato | | **login**: Login não é obrigatório, caso apenas queira enviar uma mensagem para o provedor. **\[campo obrigatório: não\]** | | **numero**: Número de contato do cliente | | **email**: Email de contato do cliente. | | **assunto**: Titulo do assunto
**EX**: Financeiro, Dúvidas, Conexão, Cadastro, Crítica, Sugestão, Outros | | **msg**: O corpo da mensagem que será incluído no contato desempenha um papel crucial na comunicação eficaz. | tags: - Contato responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string dados: type: object properties: nome: type: string login: type: string numero: type: string email: type: string assunto: type: string msg: type: string example: status: sucesso dados: nome: Jose santos login: jose numero: (68) 98181-4242 email: apiemail@gmai.com assunto: Dúvidas sobre Plano msg: >- Existe algum custo extra que eu deva estar ciente além da mensalidade? parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/inserir' /api/contato/listar/pagina=1: get: summary: Listar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_contato_listar_yml description: >- #### Endpoint: api/contato/listar ##### Método: GET **Descrição**: Retorna uma lista de contatos no formato JSON. **Paginação** A paginação é iniciada na página 1 por padrão. Para navegar entre os registros, o total de páginas é incluído no corpo da resposta, auxiliando na navegação. | Parâmetros de consulta | Descrição | Exemplo | | --- | --- | --- | | `pagina:` | Paginação para navegar entre os registros.(pagina padrão 1). | /listar/pagina=2 | | `limite:` | Quantidade de registros que serão retornados (limite maximo 500 padrão) _parâmetro opcional_ | /listar/pagina=9&limite=150 | **Filtro para consulta** Este endpoint aceita parâmetros para filtrar os resultados. Após api/contato/listar, adicione uma barra **`/`** e os parâmetros desejados. | Observação | Exemplo | | --- | --- | | Todos os parâmetros retornados na resposta **"contatos":** deste endpoint podem ser utilizados para filtrar os resultados da consulta, separando-os com **`&`**. | listar/nome=Ada | tags: - Contato responses: '200': description: '' content: application/json: schema: type: object properties: total_registros: type: number consulta_atual: type: number pagina_atual: type: number total_paginas: type: number contatos: type: array items: type: string properties: '0': type: object properties: uuid: type: string nome: type: string assunto: type: string msg: type: string ip: type: string email: type: string login: type: string telefone: type: string data: type: string '1': type: object properties: uuid: type: string nome: type: string assunto: type: string msg: type: string ip: type: string email: type: string login: type: string telefone: type: object data: type: string '2': type: object properties: uuid: type: string nome: type: string assunto: type: string msg: type: string ip: type: string email: type: string login: type: string telefone: type: string data: type: string example: total_registros: 3 consulta_atual: 3 pagina_atual: 1 total_paginas: 1 contatos: - uuid: F47838E5-2A11-43E9-9442-7056F0A99825 nome: Lise assunto: Dúvidas msg: >- Olá, recentemente notei uma luz vermelha acesa no meu rádio. Não encontrei informações sobre isso no manual. Poderia esclarecer o significado dessa luz? Estou preocupado com possíveis problemas. Agradeço pela orientação. ip: 192.168.88.100 email: email.sem.email@gmail.com login: lise telefone: '' data: '2024-01-05 09:17:01' - uuid: 0f175d97-a4c4-11ee-9bc4-080027c29949 nome: Jose santos assunto: Dúvidas sobre Plano msg: >- Gostaria de entender melhor quais são os serviços cobertos pelo meu plano. ip: 192.168.88.100 email: apiemail@gmai.com login: jose telefone: null data: '2023-12-27 10:27:30' - uuid: ea83c7a5-9f4d-11ee-9b1b-080027c29949 nome: Jose santos assunto: Dúvidas sobre Plano msg: >- Existe algum custo extra que eu deva estar ciente além da mensalidade? ip: 192.168.88.100 email: apiemail@gmai.com login: jose telefone: (68) 98181-4242 data: '2023-12-20 11:39:12' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/contato/6d19058a-a679-11ee-9c16-080027c29949: delete: summary: Remover operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_contato_remover_yml description: >- #### Endpoint: api/contato/{uuid do contato} ##### Método: DELETE **Descrição**: Deleta um contato específico passando o UUID no parâmetro da URL. tags: - Contato responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Registro excluido com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/contato/show/AD116C48-B4AF-4574-B75C-653DFFC606DD: get: summary: Show operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_contato_show_yml description: >- #### Endpoint: api/contato/Show/{uuid do contato} ##### Método: GET **Descrição**: Retorna os detalhes de um contato específico em formato JSON. tags: - Contato responses: '200': description: '200' content: application/json: schema: type: object properties: id: type: string uuid_contato: type: string nome: type: string login: type: string telefone: type: string assunto: type: string msg: type: string data: type: string ip: type: string email: type: string arquivo: type: string example: id: '164' uuid_contato: AD116C48-B4AF-4574-B75C-653DFFC606DD nome: Lise login: lise telefone: '' assunto: Financeiro msg: "Ja paguei a fatura no cartão, mais ainda não foi liberado o acesso.\r\n" data: '2023-12-15 15:59:00' ip: 192.168.88.100 email: lise7teste1api@gmail.com arquivo: 9cc6ad87166e4_recibo_confia.png parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/contaspagar/editar: put: summary: Editar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_contas_a_pagar_editar_yml description: >- #### Endpoint: api/contaspagar/editar ##### Método: POST **Descrição**: Editar uma conta. | _**Campo**_ | _**Limite/Valor**_ | | --- | --- | | `uuid` | 48 caracteres | | `valor` | 12,2 / DECIMAL | | `status` | **(aberto**, **vencido**, **liquidado)** | | `nome` | 50 caracteres | | `valorpago` | 12,2 / DECIMAL | | `vencimento` | DATETIME | | `linhadigitavel` | 64 caracteres | | `qrcode` | LONGTEXT | | `historico` | 255 caracteres | | `tipoconta` | 255 caracteres | | `obs` | LONGTEXT | | `zap` | "**sim**" ou "**nao**" | | `celular` | 32 caracteres | | _**Observação**_ | | --- | | **uuid**: Identificação da conta a ser editada. | | **valor**: Especifica o valor da conta. | | **status**: status da conta (aberto, vencido, liquidado). | | **nome**: Nome da conta para facilitar a identificação. | | **valorpago**: Valor pago da conta. | | **vencimento**: Data de vencimento da conta. | | **linhadigitavel**: Código de barras da conta. | | **qrcode**: Código para copiar e colar (como PIX, etc.). | | **historico**: Descrição da conta. | | **tipoconta**: Tipo da conta (ex: aluguel, condomínio, luz, água, etc.) | | **obs**: Observações adicionais. | | **zap**: Se deseja receber notificação ou não no dia de vencimento (**sim**/**não)**. | | **celular**: Número de celular para receber notificação. | tags: - Contas a Pagar responses: '200': description: '' content: application/json: schema: type: object properties: status: type: string mensagem: type: string dados: type: object properties: uuid: type: string valor: type: number status: type: string valorpago: type: number vencimento: type: string nome: type: string historico: type: string obs: type: string tipoconta: type: string linhadigitavel: type: string qrcode: type: string zap: type: string celular: type: string example: status: sucesso mensagem: Conta editada com sucesso dados: uuid: 3fe31537-42ac-11ef-bc4a-080027131f30 valor: 797.97 status: vencido valorpago: 0 vencimento: '2023-06-07' nome: 'Imóvel: Avenida 457' historico: >- Este pagamento refere-se ao aluguel do período de 01/07/2024 a 31/07/2024 obs: >- Pagamentos atrasados terão multa de 2% e juros de 0,33% ao dia. vencido tipoconta: moveis linhadigitavel: '7827123623265326' qrcode: ChaveAleatoriaPixTesteApiMk-Auth-PUT zap: nao celular: '83838383838' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/editar' /api/contaspagar/estornar: put: summary: Estornar operationId: >- c_users_pedrofilho_documents_bruno_mk-auth_api_contas_a_pagar_estornar_yml description: |- #### Endpoint: api/contaspagar/estornar ##### Método: POST **Descrição**: Dar baixa em uma conta. | _**Campo**_ | _**Limite/Valor**_ | | --- | --- | | `uuid` | 48 caracteres | | _**Observação**_ | | --- | | **uuid**: Identificação da conta a ser estornada. | tags: - Contas a Pagar responses: '200': description: '' content: application/json: schema: type: object properties: status: type: string mensagem: type: string dados: type: object properties: uuid: type: string example: status: sucesso mensagem: Conta estornada com sucesso dados: uuid: 3fe31537-42ac-11ef-bc4a-080027131f30 parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/estornar' /api/contaspagar/inserir: post: summary: Inserir operationId: >- c_users_pedrofilho_documents_bruno_mk-auth_api_contas_a_pagar_inserir_yml description: >- #### Endpoint: api/contaspagar/inserir ##### Método: POST **Descrição**: Insere uma nova conta a pagar. | _**Campo**_ | _**Limite/Valor**_ | | --- | --- | | `fornecedor_uuid` | 48 caracteres | | `valor` | 12,2 / DECIMAL | | `nome` | 50 caracteres | | `emissao` | DATETIME | | `vencimento` | DATETIME | | `linhadigitavel` | 64 caracteres | | `qrcode` | LONGTEXT | | `historico` | 255 caracteres | | `tipoconta` | 255 caracteres | | `obs` | LONGTEXT | | `zap` | "**sim**" ou "**nao**" | | `celular` | 32 caracteres | | _**Observação**_ | | --- | | **fornecedor_uuid**: A conta pode estar vinculada a um fornecedor ou a um funcionário usando o **UUID**.
Esses UUIDs podem ser obtidos em **/api/fornecedores/listagem** ou **/api/funcionarios/listagem**, onde você pode pegar o **uuid** do **fornecedor** ou **funcionário** desejado. | | **valor**: Especifica o valor da conta. | | **nome**: Nome da conta para facilitar a identificação. | | **emissao**: Data de emissão da conta. | | **linhadigitavel**: Código de barras da conta. | | **qrcode**: Código para copiar e colar (como PIX, etc.). | | **historico**: Descrição da conta. | | **tipoconta**: Tipo da conta (ex: aluguel, condomínio, luz, água, etc.) | | **obs**: Observações adicionais. | | **zap**: Se deseja receber notificação ou não no dia de vencimento (**sim**/**não)**. | | **celular**: Número de celular para receber notificação. | tags: - Contas a Pagar responses: '200': description: '' content: application/json: schema: type: object properties: status: type: string mensagem: type: string dados: type: object properties: fornecedor_uuid: type: string valor: type: number nome: type: string emissao: type: string vencimento: type: string linhadigitavel: type: string qrcode: type: string historico: type: string tipoconta: type: string obs: type: string zap: type: string celular: type: string example: status: sucesso mensagem: A conta foi inserida com sucesso dados: fornecedor_uuid: a70accbe-a67b-11ee-9c16-080027c299497 valor: 360 nome: 'Imóvel: Avenida Central 457' emissao: '2023-04-17' vencimento: '2023-06-17' linhadigitavel: '07070707070707070707070' qrcode: ChaveAleatoriaPixTesteApiMk-Auth historico: >- Este pagamento refere-se ao aluguel do período de 01/07/2024 a 31/07/2024 tipoconta: aluguel obs: >- Pagamentos atrasados terão multa de 2% e juros de 0,33% ao dia. zap: sim celular: '83838383838' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/inserir' /api/contaspagar/liquidar: put: summary: Liquidar operationId: >- c_users_pedrofilho_documents_bruno_mk-auth_api_contas_a_pagar_liquidar_yml description: |- #### Endpoint: api/contaspagar/liquidar ##### Método: POST **Descrição**: Dar baixa em uma conta. | _**Campo**_ | _**Limite/Valor**_ | | --- | --- | | `uuid` | 48 caracteres | | `valorpago` | 12,2 / DECIMAL | | _**Observação**_ | | --- | | **uuid**: Identificação da conta a ser liquidada. | | **valorpago**: Valor pago da conta. | tags: - Contas a Pagar responses: '200': description: '' content: application/json: schema: type: object properties: status: type: string mensagem: type: string dados: type: object properties: uuid: type: string valorpago: type: string example: status: sucesso mensagem: Conta liquidado com sucesso dados: uuid: 3fe31537-42ac-11ef-bc4a-080027131f30 valorpago: '110.0' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/liquidar' /api/contaspagar/listar/pagina=1: get: summary: Listar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_contas_a_pagar_listar_yml description: >- #### Endpoint: api/contaspagar/listar ##### Método: GET **Descrição**: Retorna uma lista de contas a pagar no formato JSON. **Paginação** A paginação é iniciada na página 1 por padrão. Para navegar entre os registros, o total de páginas é incluído no corpo da resposta, auxiliando na navegação. | Parâmetros de consulta | Descrição | Exemplo | | --- | --- | --- | | `pagina:` | Paginação para navegar entre os registros.(pagina padrão 1). | /listar/pagina=2 | | `limite:` | Quantidade de registros que serão retornados (limite maximo 500 padrão) _parâmetro opcional_ | /listar/pagina=9&limite=150 | **Filtro para consulta** Este endpoint aceita parâmetros para filtrar os resultados. Após api/contaspagar/listar, adicione uma barra **`/`** e os parâmetros desejados. | Observação | Exemplo | | --- | --- | | Todos os parâmetros retornados na resposta **"contaspagar":** deste endpoint podem ser utilizados para filtrar os resultados da consulta, separando-os com **`&`**. | listar/status=vencido | tags: - Contas a Pagar responses: '200': description: '' content: application/json: schema: type: object properties: total_registros: type: number consulta_atual: type: number pagina_atual: type: number total_paginas: type: number contaspagar: type: array items: type: string properties: '0': type: object properties: nrdocumento: type: string status: type: string uuid: type: string valor: type: string planodecontas: type: string historico: type: string vencimento: type: string emissao: type: string valorpago: type: object datapg: type: string linhapgdig: type: object fornecedor: type: string '1': type: object properties: nrdocumento: type: string status: type: string uuid: type: string valor: type: string planodecontas: type: string historico: type: string vencimento: type: string emissao: type: string valorpago: type: string datapg: type: string linhapgdig: type: object fornecedor: type: string '2': type: object properties: nrdocumento: type: string status: type: string uuid: type: string valor: type: string planodecontas: type: string historico: type: string vencimento: type: string emissao: type: string valorpago: type: string datapg: type: string linhapgdig: type: string fornecedor: type: string '3': type: object properties: nrdocumento: type: string status: type: string uuid: type: string valor: type: string planodecontas: type: string historico: type: string vencimento: type: string emissao: type: string valorpago: type: string datapg: type: string linhapgdig: type: string fornecedor: type: string '4': type: object properties: nrdocumento: type: string status: type: string uuid: type: string valor: type: string planodecontas: type: string historico: type: string vencimento: type: string emissao: type: string valorpago: type: string datapg: type: string linhapgdig: type: string fornecedor: type: string '5': type: object properties: nrdocumento: type: string status: type: string uuid: type: string valor: type: string planodecontas: type: string historico: type: string vencimento: type: string emissao: type: string valorpago: type: string datapg: type: object linhapgdig: type: string fornecedor: type: string example: total_registros: 6 consulta_atual: 6 pagina_atual: 1 total_paginas: 1 contaspagar: - nrdocumento: '77' status: vencido uuid: 966F386C-53A4-4669-9880-DDD7D0DE0739 valor: '99.99' planodecontas: aluguel historico: 6y vencimento: '2023-08-17 00:00:00' emissao: '2023-08-17 00:00:00' valorpago: null datapg: '2024-07-12 14:54:18' linhapgdig: null fornecedor: TecnoSupplies - nrdocumento: '123' status: liquidado uuid: D73E184B-D0B2-4416-AEA6-C88C3E125A3F valor: '1320.00' planodecontas: salario historico: testes vencimento: '2023-09-20 00:00:00' emissao: '2023-09-20 00:00:00' valorpago: '1320.00' datapg: '2024-07-12 14:55:06' linhapgdig: null fornecedor: Marie Curie - nrdocumento: '1234567' status: vencido uuid: EBA6F0A1-9F51-4660-8F62-367348CE4C55 valor: '700.00' planodecontas: horasextras historico: Pagamento por hora extra vencimento: '2024-03-22 00:00:00' emissao: '2023-09-22 00:00:00' valorpago: '710.00' datapg: '2024-07-12 14:55:42' linhapgdig: 34191.75009 00041.699653 70144.380006 1 94640000080000 fornecedor: Marie Curie - nrdocumento: Aluguel do mês de junho status: liquidado uuid: 5E08F0B5-F92A-4530-A381-7CE3C4B89379 valor: '1200.00' planodecontas: moveis historico: 'Compra de materiais para escritórios ' vencimento: '2024-08-17 00:00:00' emissao: '2024-06-28 00:00:00' valorpago: '1200.00' datapg: '2024-07-12 14:56:15' linhapgdig: 75493.75293 47594.387520 97498.573495 7 90324750974902 fornecedor: TecnoSupplies - nrdocumento: 'Imóvel: Avenida 457' status: liquidado uuid: 9f5031c9-3d27-11ef-ac03-080027131f30 valor: '79.97' planodecontas: moveis historico: >- Este pagamento refere-se ao aluguel do período de 01/07/2024 a 31/07/2024 vencimento: '2023-06-17 00:00:00' emissao: '2023-04-17 00:00:00' valorpago: '80.00' datapg: '2024-07-12 14:56:51' linhapgdig: '7827123623265326' fornecedor: Marie Curie - nrdocumento: 'Imóvel: Avenida Central 457' status: vencido uuid: 6e5f326b-407c-11ef-80e6-080027131f30 valor: '360.00' planodecontas: aluguel historico: >- Este pagamento refere-se ao aluguel do período de 01/07/2024 a 31/07/2024 vencimento: '2023-06-17 00:00:00' emissao: '2023-04-17 00:00:00' valorpago: '0.00' datapg: null linhapgdig: '07070707070707070707070' fornecedor: TechNet Solutions parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/contaspagar/3fe31537-42ac-11ef-bc4a-080027131f30: delete: summary: Remover operationId: >- c_users_pedrofilho_documents_bruno_mk-auth_api_contas_a_pagar_remover_yml description: >- #### Endpoint: api/contaspagar/{uuid da conta a pagar} ##### Método: DELETE **Descrição**: Deleta uma conta específica passando o UUID no parâmetro da URL. tags: - Contas a Pagar responses: '200': description: '' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Registro excluido com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/contaspagar/show/5E08F0B5-F92A-4530-A381-7CE3C4B89379: get: summary: Show operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_contas_a_pagar_show_yml description: >- #### Endpoint: api/contaspagar/show/{uuid da conta a pagar} ##### Método: GET **Descrição**: Retorna os detalhes específico de uma conta a pagar em formato JSON, ao passar o UUID como parâmetro. tags: - Contas a Pagar responses: '200': description: '' content: application/json: schema: type: object properties: id: type: string uuid_contaspagar: type: string fornecedor: type: string zap: type: string celular: type: string vencimento: type: string valor: type: string valorpago: type: string emissao: type: string nrdocumento: type: string usergerou: type: string historico: type: string planodecontas: type: string numparcelas: type: string observacao: type: string parcatual: type: string status: type: string datapg: type: string tipodiv: type: string linhapgdig: type: string qrcode: type: string example: id: '6' uuid_contaspagar: 5E08F0B5-F92A-4530-A381-7CE3C4B89379 fornecedor: '1' zap: sim celular: '66909809847' vencimento: '2024-08-17 00:00:00' valor: '1200.00' valorpago: '1200.00' emissao: '2024-06-28 00:00:00' nrdocumento: Aluguel do mês de junho usergerou: admin historico: 'Compra de materiais para escritórios ' planodecontas: moveis numparcelas: '1' observacao: Pagamento urgente; desconto concedido se pago ate o dia 10. parcatual: '0' status: liquidado datapg: '2024-07-12 14:56:15' tipodiv: for linhapgdig: 75493.75293 47594.387520 97498.573495 7 90324750974902 qrcode: teste parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/estoque/editar: put: summary: Editar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_estoque_editar_yml description: >- #### Endpoint: api/estoque/editar ##### Método: PUT **Descrição**: Editar produto no sistema. | _**Campo**_ | _**Limite/Tipo**_ | | --- | --- | | `uuid` | 64 caracteres | | `nome` | 255 caracteres | | `codigo` | 50 caracteres | | `valor_atual` | 12,2 / DECIMAL | | `valor_velho` | 12,2 / DECIMAL | | `valor_custo` | 12,2 / DECIMAL | | `descricao` | LONGTEXT | | `aplicacao` | LONGTEXT | | `codigo_barras` | 255 caracteres | | `estoque` | 11 / INT | | `quantidade_minima` | 11 / INT | | `peso` | 12,2 / DECIMAL | | `ipi` | 11 / INT | | `iscm` | 11 / INT | | _**Observação**_ | | --- | | **nome**: Nome do produto (não pode ser um nome já existente no estoque). | | **codigo**: Código de Identificação do Produto. | | **valor_atual**: Valor do produto. | | **valor_velho**: Preço do produto usado. | | **valor_custo**: Valor de custo do produto. | | **descricao**: Descrição detalhada do produto. | | **aplicacao**: Propósito do produto. | | **codigo_barras**: Código de barras do produto. | | **estoque**: Quantidade de unidades em estoque. | | **quantidade_minima**: Quantidade mínima de unidades em estoque. | | **peso**: Peso do produto. | | **ipi**: Porcentagem de Imposto sobre Produtos Industrializados (IPI). | | **iscm**: Porcentagem de Imposto sobre Circulação de Mercadorias e Serviços (ICMS). | tags: - Estoque responses: '200': description: '' content: application/json: schema: type: object properties: status: type: string mensagem: type: string dados: type: object properties: nome: type: string codigo: type: string valor_atual: type: string valor_velho: type: string valor_custo: type: string descricao: type: string aplicacao: type: string codigo_barras: type: string estoque: type: string quantidade_minima: type: string peso: type: string ipi: type: string icms: type: string example: status: sucesso mensagem: Produto inserido com sucesso dados: nome: Roteador Intelbras Wi-Force W5-1300G codigo: b7b1223b valor_atual: '170.00' valor_velho: '130.00' valor_custo: '150.00' descricao: >- Geração do Wi-Fi, com tecnologia Wi-Fi 6, mais velocidade trafegando, conexões simultâneas com mais qualidade e menos interferência na sua rede Wi-Fi. Ele conecta até 128 dispositivos ao mesmo tempo e é ideal para Casas Conectadas, além de cobrir até 140m² de área de cobertura aplicacao: Ideal para planos de internet de até 100 mega codigo_barras: '7890123456789' estoque: '20' quantidade_minima: '1' peso: '0.3' ipi: '6' icms: '8' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/editar' /api/estoque/inserir: post: summary: Inserir operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_estoque_inserir_yml description: >- #### Endpoint: api/estoque/inserir ##### Método: POST **Descrição**: Insere um novo produto no estoque. | _**Campo**_ | _**Limite/Tipo**_ | | --- | --- | | `nome` | 255 caracteres | | `codigo` | 50 caracteres | | `valor_atual` | 12,2 / DECIMAL | | `valor_velho` | 12,2 / DECIMAL | | `valor_custo` | 12,2 / DECIMAL | | `descricao` | LONGTEXT | | `aplicacao` | LONGTEXT | | `codigo_barras` | 255 caracteres | | `estoque` | 11 / INT | | `quantidade_minima` | 11 / INT | | `peso` | 12,2 / DECIMAL | | `ipi` | 11 / INT | | `iscm` | 11 / INT | | _**Observação**_ | | --- | | **nome**: Nome do produto (não pode ser um nome já existente no estoque). | | **codigo**: Código de Identificação do Produto. | | **valor_atual**: Valor do produto. | | **valor_velho**: Preço do produto usado. | | **valor_custo**: Valor de custo do produto. | | **descricao**: Descrição detalhada do produto. | | **aplicacao**: Propósito do produto. | | **codigo_barras**: Código de barras do produto. | | **estoque**: Quantidade de unidades em estoque. | | **quantidade_minima**: Quantidade mínima de unidades em estoque. | | **peso**: Peso do produto. | | **ipi**: Porcentagem de Imposto sobre Produtos Industrializados (IPI). | | **iscm**: Porcentagem de Imposto sobre Circulação de Mercadorias e Serviços (ICMS). | tags: - Estoque responses: '200': description: '' content: application/json: schema: type: object properties: status: type: string mensagem: type: string dados: type: object properties: nome: type: string codigo: type: string valor_atual: type: string valor_velho: type: string valor_custo: type: string descricao: type: string aplicacao: type: string codigo_barras: type: string estoque: type: string quantidade_minima: type: string peso: type: string ipi: type: string icms: type: string example: status: sucesso mensagem: Produto inserido com sucesso dados: nome: Roteador Intelbras Wi-Force W5-1300G codigo: b7b1223b valor_atual: '170.00' valor_velho: '130.00' valor_custo: '150.00' descricao: >- Geração do Wi-Fi, com tecnologia Wi-Fi 6, mais velocidade trafegando, conexões simultâneas com mais qualidade e menos interferência na sua rede Wi-Fi. Ele conecta até 128 dispositivos ao mesmo tempo e é ideal para Casas Conectadas, além de cobrir até 140m² de área de cobertura aplicacao: Ideal para planos de internet de até 100 mega codigo_barras: '7890123456789' estoque: '20' quantidade_minima: '1' peso: '0.3' ipi: '6' icms: '8' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/inserir' /api/estoque/listar/pagina=1: get: summary: Listar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_estoque_listar_yml description: >- #### Endpoint: api/estoque/listar ##### Método: GET **Descrição**: Retorna uma lista de itens do estoque no formato JSON. **Paginação** A paginação é iniciada na página 1 por padrão. Para navegar entre os registros, o total de páginas é incluído no corpo da resposta, auxiliando na navegação. | Parâmetros de consulta | Descrição | Exemplo | | --- | --- | --- | | `pagina:` | Paginação para navegar entre os registros.(pagina padrão 1). | /listar/pagina=2 | | `limite:` | Quantidade de registros que serão retornados (limite maximo 500 padrão) _parâmetro opcional_ | /listar/pagina=9&limite=150 | **Filtro para consulta** Este endpoint aceita parâmetros para filtrar os resultados. Após api/estoque/listar, adicione uma barra **`/`** e os parâmetros desejados. | Observação | Exemplo | | --- | --- | | Todos os parâmetros retornados na resposta **"produtos":** deste endpoint podem ser utilizados para filtrar os resultados da consulta, separando-os com **`&`**. | listar/ativo=sim&grupo=Roteadores | tags: - Estoque responses: '200': description: '' content: application/json: schema: type: object properties: total_registros: type: number consulta_atual: type: number pagina_atual: type: number total_paginas: type: number produtos: type: array items: type: string properties: '0': type: object properties: uuid: type: string id: type: string estoque: type: string nome: type: string grupo: type: string ativo: type: string '1': type: object properties: uuid: type: string id: type: string estoque: type: string nome: type: string grupo: type: string ativo: type: string '2': type: object properties: uuid: type: string id: type: string estoque: type: string nome: type: string grupo: type: string ativo: type: string '3': type: object properties: uuid: type: string id: type: string estoque: type: string nome: type: string grupo: type: string ativo: type: string '4': type: object properties: uuid: type: string id: type: string estoque: type: string nome: type: string grupo: type: object ativo: type: string example: total_registros: 5 consulta_atual: 5 pagina_atual: 1 total_paginas: 1 produtos: - uuid: 1A14802A-DC44-4D3C-96B2-2E6CEC038DB1 id: '8' estoque: '84' nome: Roteador Intelbras Wi-Force W5-1200F grupo: Roteadores ativo: sim - uuid: C63097DB-4692-454C-85A2-51B7FBA0F815 id: '9' estoque: '143' nome: 'Repetidor TP-Link WiFi Range Extender AC750 ' grupo: Repetidor ativo: sim - uuid: C4736616-B59D-481E-9E5A-DE7A1A22F840 id: '10' estoque: '494' nome: Cabo de Rede Cat 6, 5 metros grupo: ' Cabos de Rede' ativo: sim - uuid: 3F17BD53-BFAE-41ED-BED3-4C3632E760D0 id: '45' estoque: '76' nome: >- Roteador e Repetidor D-Link N300 Mbps TR-069 Preset VLAN, 2 Antenas, Provedor - DIR-615 X1 grupo: Roteadores ativo: sim - uuid: 01HRS55Q7BMQEWQBXBTSAYYCT6 id: '65' estoque: '20' nome: Roteador Intelbras Wi-Force W5-1300G grupo: null ativo: sim parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/estoque/quantidade: put: summary: Quantidade operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_estoque_quantidade_yml description: >- #### Endpoint: api/estoque/quantidade ##### Método: PUT **Descrição**: Endpoint para modificar a quantidade de um produto específico no estoque. | _**Campo**_ | _**Limite/Tipo**_ | | --- | --- | | `uuid` | 48 caracteres | | `estoque` | 11 / INT | | _**Observação**_ | | --- | | **uuid**: Identificador do produto a ser modificado. | | **estoque**: Quantidade a ser adicionada ou removida do estoque. | tags: - Estoque responses: '200': description: '' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Estoque atualizado com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/quantidade' /api/estoque/01HRSSM6M7SQXZ2J3YZ9XZHMX9: delete: summary: Remover operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_estoque_remover_yml description: >- ### Endpoint: api/estoque/{uuid do produto} #### Método: DELETE **Descrição**: Remove um produto específico, passando o UUID como parâmetro na URL. tags: - Estoque responses: '200': description: '' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Produto deletado com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/estoque/show/1A14802A-DC44-4D3C-96B2-2E6CEC038DB1: get: summary: Show operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_estoque_show_yml description: >- #### Endpoint: api/estoque/show/{uuid do produto} ##### Método: GET **Descrição**: Retorna dados de um produto específico em formato JSON, passando o UUID como parâmetro na URL. tags: - Estoque responses: '200': description: '' content: application/json: schema: type: object properties: id: type: string uuid_produto: type: string nome: type: string idforn: type: string descricao: type: string precoatual: type: string precovelho: type: string precocusto: type: string datacad: type: string ultcompra: type: string ultalteracao: type: string peso: type: string ativo: type: string codbarras: type: string grupo: type: string med: type: object aplicacao: type: string ipi: type: string icms: type: string codigo: type: string idprod: type: string qtdmin: type: string estoque: type: string example: id: '8' uuid_produto: 1A14802A-DC44-4D3C-96B2-2E6CEC038DB1 nome: Roteador Intelbras Wi-Force W5-1200F idforn: '15' descricao: >- Geração do Wi-Fi, com tecnologia Wi-Fi 6, mais velocidade trafegando, conexões simultâneas com mais qualidade e menos interferência na sua rede Wi-Fi. Ele conecta até 128 dispositivos ao mesmo tempo e é ideal para Casas Conectadas, além de cobrir até 140m² de área de cobertura. precoatual: '170.00' precovelho: '130.00' precocusto: '150.00' datacad: '2024-02-05 09:03:25' ultcompra: '2024-02-05 00:00:00' ultalteracao: '2024-02-15 10:52:50' peso: '6.00' ativo: sim codbarras: '7890123456789' grupo: Roteadores med: null aplicacao: Ideal para planos de internet de até100 mega ipi: '10' icms: '18' codigo: '4750077' idprod: '8' qtdmin: '50' estoque: '84' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/empresa/dados: put: summary: Dados operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_empresa_dados_yml description: >- #### Endpoint: api/empresa/dados ##### Método: PUT **Descrição**: Editar os dados da Empresa. | _**Campo**_ | _**Limite/Valor**_ | | --- | --- | | `id` | 11 caracteres | | `nome` | 255 caracteres | | `responsavel` | 255 caracteres | | `cargo` | 64 caracteres | | `razao` | 255 caracteres | | `cnpj` | 255 caracteres | | `endereco` | 255 caracteres | | `numero` | 255 caracteres | | `bairro` | 255 caracteres | | `cidade` | 255 caracteres | | `cidade_ibge` | 16 caracteres | | `estado` | 255 caracteres | | `cep` | 255 caracteres | | `telefone` | 255 caracteres | | `fax` | 255 caracteres | | `celular` | 255 caracteres | | `email` | 255 caracteres | | `site` | 255 caracteres | | _**Observação**_ | | --- | | **id**: O ID do provedor é necessário para atualizar os dados, sendo o padrão **0**. | | Para atualizar os dados é necessário preencher todos os campos. | tags: - Empresa responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string dados: type: object properties: nome: type: string responsavel: type: string cargo: type: string razao: type: string cnpj: type: string endereco: type: string numero: type: string bairro: type: string cidade: type: string cidade_ibge: type: string estado: type: string cep: type: string telefone: type: string fax: type: string celular: type: string email: type: string site: type: string id: type: number example: status: sucesso mensagem: Dados atualizados com sucesso dados: nome: Empresa Teste API responsavel: Jose S cargo: CEO razao: Empresa de Teste LTDA cnpj: 12.345.678/0001-90 endereco: Rua Teste, 123 numero: '123' bairro: Centro cidade: São Paulo cidade_ibge: '3550308' estado: SP cep: 01234-567 telefone: (11) 1234-5678 fax: (11) 9876-5432 celular: (11) 99999-9999 email: teste@example.com site: http://www.example.com id: 0 parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/dados' /api/empresa/listagem: get: summary: Listagem operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_empresa_listagem_yml description: |- #### Endpoint: api/empresa/listagem ##### Método: GET **Descrição**: Retorna uma lista dos dados da empresa em formato JSON. tags: - Empresa responses: '200': description: '200' content: application/json: schema: type: object properties: id: type: string uuid_provedor: type: string nome: type: string endereco: type: string bairro: type: string cidade: type: string cidade_ibge: type: string estado: type: string fone: type: string site: type: string email: type: string cep: type: string cnpj: type: string responsavel: type: string token: type: string celular: type: string razao: type: string fax: type: string nextel: type: object zero_oito: type: string ie: type: string cargo: type: string fistel: type: string codigo_receita: type: string coordenadas: type: string idforn: type: string im: type: string twitter: type: string facebook: type: string instagram: type: string whatsapp: type: string tiktok: type: string linkedin: type: string youtube: type: string telegram: type: string skype: type: string kwai: type: string logomarca: type: string example: id: '0' uuid_provedor: EFCB761A-C78A-48F4-A708-05CBE959D828 nome: Empresa Teste API endereco: Rua Teste, 123 bairro: Centro cidade: São Paulo cidade_ibge: '3550308' estado: SP fone: (11) 1234-5678 site: http://www.example.com email: teste@example.com cep: 01234-567 cnpj: 12.345.678/0001-90 responsavel: Jose S token: '99431' celular: (11) 99999-9999 razao: Empresa de Teste LTDA fax: (11) 9876-5432 nextel: null zero_oito: 789 456-0123 ie: isento cargo: Gerente fistel: '123' codigo_receita: '1015' coordenadas: '-4.027433,-38.4649854' idforn: '2' im: '' twitter: elonmusk7 facebook: '@facebook7' instagram: '@instagram7' whatsapp: '7777' tiktok: '@tiktok7' linkedin: '@linkdin7' youtube: meu canal7 telegram: '77819987695387' skype: '@skype7' kwai: '@kwai7' logomarca: >- iVBORw0KGgoAAAANSUhEUgAAAEsAAABLCAIAAAC3LO29AAAVtElEQVR4nN17e5RdVZ3m9/32PvdWFalAzANIJSnDQ+xoI29oQMGG1nFQUBlUnFF7+aDlTQtCLwkQSaRZ09qtjCAirSBLtG2hw0MJrQM+YGQaoRUGIbwCJMG8ICSVVNU9Z+/fN3+cW0kglepbJeKs+a1auZW65+y9v/N7Pw4n7/51/BFJARCYAKNMAOiUtb+kAw5FABz5r8NsPDvEV//Q4yG3YVOgItgSCwdABwCYCQ6AMCQAAqAIjnuLcT2OPwCpCTjgUpczgQmKBhgS4UFmHp1wRIeBCSpM4zvzH5eHbnCokelUUhWCWVBLYcWUqWHqlJ3XrB3aPCD33VzJITAAA1ABhs73+KMiVATohMGDD73/hDd85YrjupswQAIJEC6vaGeeueSmm34j2zWnpmPzuJjI38/SOGBtY9DWn3Gv4LDAzbcv/uvDDgaBJPzrnc+sWrXmAyceslMvAhKBEnHpEzjiiCsVCzCZxsGYiSGsTVw32HLEoAS6OhMHRzCJSKIBLg8H/Gn6yb+eCuKpJ/DWoxcmTcsqFCpU7Aorb/3hwkP3E51uuPun6f0fvl6hpI9DSidmaczV7cyAAcyMGY2O0AEmERDNAYfN7d9w94//KqJ8+Nf4s6OvHdS0HAgmlQZYZf3H/qe/Q2a2RKZj3h4Zno0aBzwAodn7nvEjdMJIj9gEuEigEzNOyIgEwGkAIzY9/si50ZQY9z/w8xUn59wyi5SBDktZErojh448fDYYKQy2il/et25cPmNCPFQEVHD1ypWfue2WM6OK0KkFJ5jFRFfhm8447YgiuGS/+lUqMTPnHGPTMqHgFoRGFAurvvCle4lAQciXXHCk2apxHXZCCOmJlVdDTeLQA5F9iKEjM0NBCI5oZru+bvCSCw+hrAROeN/CtmYmEwzMFEwBKoSCmloKIEjCcNTbZvzhEQJmFotuJpCQUx2pvssyFAGT9K1vfi4wAdgwgKo1rfLYRLSQnA6kIAezrHI6oWeehVDBCeKk9x47vqNOCCAaiDk0W0IkioZZR+vYyEfplg49BLU3/vSnr0boCZSrkmgAENufMJOJ6YYbHyAKmEw44b17AoCMCLX16mjX8VLOyomPPwEA7psyqk7ucoBIgDXseRqABPo9v3gqq2ZdreHbHdHsnp//WhIAEkUTQgm6pE7OP0GEAqDigQdXSIiWyNzpnXTA+mftJE9qM2AXmACI8NGMZBaWLn2WVM5qr8FMiuzIpE488qY17/rZQyQiy9yZ/TYZZJB94qPvJKMxKiOlbgQzjXVjqgKAELZou7m7e0fmbeIIU84P/vpxAp5LdbpO7Tr92GP3EySCZmJIOUORAphGu4dSbm8hQJBHMqDOHgGM6asmiJAkYGtfeBFAiBpdvEbbTgDgfbNACkh1whBCoOoVRmGLmSFsXb8qQQZJ1lkmPGE9zGYxlxTQ1U1yTCEbIadnA4UYRrYm4Mqp1I4fkafcP3cG4PLkwPe+/1u0GTtiacYM+l+FDDjG2KHSA9lkQMwOAIQJojwUEczi6LbUg955zCFABgOBK6+6bVzHmzDC9mNz39YAdLrZ6jUAIJFUCGXtCXZ0Hpod8/aDiILMrQrLVwyP66C/Jw/NDCGEjpNDp0z0n979WwAEJTWLF4Mb5Q6EUYTdVfJtR9QyYnf9/EVX3/iOOK6rRz+10jZMGPPKtiyn66+/s11WYzj+PYdIBEwEsL0tNbMNI1JiH/nYFSzGV5d4FRDuSAl9y+KvtOb26NJVLq//fs7Z/yUSIqgRm1G7zfa9oad7A+HuyELOu5bV4LiON2GEIyVNIScRYXskhkSBHkB3ute+giVgpWa1I0/XnD2wU89KZIOnjAaQYC0ChVHZY0zLnlyYKzdi7zdeKhZBzdcGYVvxSOScJaFOW7HlB4Bl8xxaQApuJqtLvQ6jNW+++cVMyNiAP/Ho58EBi11NE9So2CxDauUYG9XuMzY2AQvxsWV4YXB6UrJO7fbvi/BlJGlrhAGDImo8MiE60XZ3CgBMdPczTv9qEoiEbAXQLFYjy1NBloWXQTBWPXH1A/d/lob1gzjyrQurpFjA9ZraUgDIOW+jimZsAgiROWwOzE1vdvmLRxzatctO62QVvAlWZEjYffbs+SlFGnJMv3vu8rf8ybocV5BdNG/ihRuuffczyxY1DItv37THG65KNrupyKrIfM0rwiltYwBlQmIYTHmwgfKaq897z3E9RXC63XLbyo+eepvYDkTcMFz29+110fKnFwbEAPzsrnMzGBAAUMgZv/j55o9+5G8HqtmVx4CNxh6xJXWjs2Tt90JI1cYdEnxrYuHkUODAnP6ezy84/7hjLFgCUgKz44orbwaaoEMG5pxl0QaGZvbNXXDRee8+7dSDksdmgAQBK1fjHcdfunrNlOw7B1vfZDJW0mAmItcjTxGi18kK3eljlPonWBEOxLCn7rhq3fIFc15/7nAZP3jSWy+//Pi6Yg1DRnaEZ5/Gd2588KqrF1c+BbbTdumOQ9HpBlgqGVqyDAtqhVgMfukrJ37o/ftEAXXlzSDACTmS4/CjLn/q6UlEF5l9zNxtgggZm/IXvvb3//XDJ07JoYF2TozkWLDgjm/f8MtWOdmxM1h5ZkLMlhsRTNs/aYci4QAyDWxNn7z+0Ufnx7oUiwRFQYCPuF2DACQxVsBuMy+hvT7nrB0HVRNCKMusZvRuevyxz0ZHy1BVOOOsf7r19kdynuboRUhSDh5J1nmqBTezLUn61u0FwMTkKMxf2nmnDcueuDRYAqIwTHW1HwNrd2QUJGSrIgogPfO7eOAhX880pR0GVRNBSDljZu4xrM1Ezt20JuUjltkdMotZbX8vceTzZU/aATrNKvcGOfjcU2ft3AWYQwKCA0kwYenjeOS3GwcHh/fee8rBhxaBCEJ2BaOIt73jfzz8aI/yDssoE5RSi83c2syGlcrdalZWIYetIuiZwUimNiIDHKPaAxljZLXuuWXn9dYMIyC0Ksyee8Gwz3HEwoqcs5nllCiPcXD18nOLgMwUhBJxt74vZEzf4VEnAA9AapVBxpybuckUDAyCw9xajbh2v32bx71zbm69ZE46DckwSq2BAlimcmCvN+TeJsCUXQK+ft1TM+deVmIPohlZJJSInlBaCLKQsUv/Gy4QIBCKAdhjboRsR5XFiVoaQYQDypWxkZyxWL/4n0897OBJzQAXgmHFWhx40D8OVR7BbElAkFMN0R1mAuEwfuLjf3L5wiOLDIUExDfvt2j5mskMXUwOFbJqFDaoeuSh02dNy0DIxAP3V39x/LfdhomGeRbNYYat8jN+kmXC6VGJDEV44eQTpm5Y8dmjDp30t5fdNW3WP0zv+9rM2Qt2m47sRkqgyTjyYChAhdNFD1zzxYVHFnIFJI8nnvytlWunwqYQBQDZKJ7dATCc8skbQMpdyPsdUEAlGbepoG7l54Q8PttK5bSgcskP/+aA/bCphdlz50t7yiY5fVgRDhmN8CxDXaEwwIAMVnXL/qqvfpzZ6/Dhe//8xE/v2eRswHNmK9ShD5O9MmUBYPf/2+OS0UAkIyyoNjUa0fktSjERHlJAqhJEG1638owD3oJvXvfMzFlXELPJQXMi5Mzex5Yi5eGqatXZRlts2BJh8Khgee2Jx++ukMlQlTjrMz8pU5flYBoODjFBhtFyJSK4heTt+jIEqGKdX7PuUm69eCI8FNHVnEw9+uyyyxEwq/+ioTTHiijJEWUp5gbVOPyYayMikcyDrG6IuwiHRUPIA7cvudAsEwWEOXtf1EozuyI91zmWAUZ4ELYvw0lytEEYLAOmWg9yO3vexi1NgIfusCq/9OzSy7uJU069abDshywrCAURTS66m6c6M7TmiLdI7cQKTO4hbNhvf8gDHAkYTJMbxuxUGAbMYY4AOEepa0DIZACxxYQ6zN1HrTZ0iNDrZ+NqZQXm8qH7z+7qxvcWr7j5llUpl0IOJJjB3JYLWTM3RXcIrO2h1e0XQwWEJUsWNJGMAHHxJT8WJ7mCzKECgMENWTTnKFImU5BHtic5HEAIpLYV1C3UkZRmRjJFB9ADW/e+4/edMxP/7WM33n5XWXloxqasekVUXfeYpG5nZawnt0IdvRIefPhNbwYVBSXn1dc+KJvWCFVWIXTS5GkcddQ8oU69seTO51NyszhSJn4ZdcRDCiYI5sxNbrjma++qHHcsWZdVScxe5u2CJhHJvDIX69g6mVBbOcGKsCnUJX3yth+uzJgiyR0d1uzk+YMfPJoEYC4svuXeGBuSRr29I4RBoJAJWnruucuCY9dZ81PRW3hqhOxs2Pb5i2JTjaa8aYxEqbUKrbY5VZwzx9vOADr73K8kKKiUig7rruY64fgZgkg6sfj2f99OCW2U33ZE3v7HACy68LAA/OphKPQJw0QhNWGtUaSdSfGl6VPW3vaDv1qz8pMvPX/RsYd1U7Fe74wzT6o3N3Bg0y5kMI/Z8thdpK2H5guFuYkS7vvlgKN/jIs70EO6FMFkrM781AEV8e73np/TnsYis/K6t/IyHjo5FLlx8fcuPvhwNpCImIHfPPwsNBuE0w/af6/sw7SmQRnd9aQNage4/f6C6E5scf1/um8PkSWD+fkXfCOnXgtb1KRuwm11GB10iWXyJAz/+VtnMGD/gy6uyr0MgZ7gwZHJoOySkju08RMn961b8derVlxy2OH8h//+i+VPRRckrN/Yl00OC0j77I1gXWxP2PQGoAop5MKtHP0hK0ImNyJUGvyfS87Oua4k2NKnG0QeiZZG4HCcUZvcgj3/T985J2WsfH6WEABlFrIsl3myRnn4IX033fQBA5ixdg3ed/zCR5a97rj/POO888VMCVkOBpOBdcs4EVGAkMUIOliZN16pirJsyeTBmzQXhveaXZEgCwjf/MZzRI/HNFrDYzwIQwhf/uLZRcDXrnrSLWZlWgWIYg/94EMm/eO1p+8+DXQk4JTTv7v49hdSnuJWfPWqk0yggQkhFK4EAggAlI0GEtGqSmHrIPAo++d61GjYqx576Z67LjS40SDMX3BD0jQLedS23HgQFq2PfLjPhfmLbgo2RaR57Ak45tje6795cjBAWL8Re867EDa1avVa0SNL3eG5qd341nUPfORjB65dX1dyI+VifPJpzNvLILny1Cmr1q7dJ4dWthTcX6k4dMtG9IhVtPDMkxf2RmWZ6E8+ba0wPchSidHigjZ1ZLtmTFtHx4svIaNXlZiAXH73+6d847oPgrj+u0un91+0x7yrzfbJrckWqqAUmZc+sqgqce6FPzDHhpegumaGCOCcz1yZCdDh4de/WdSMK4KSRr59BZEBYVjafOfiv+ztASKJtH6jHfn2L9MFmcJYKMb4bksC4gsXfoKGs8/6NtRgMAuQFZ8+9Yplz9m8N1961md+MpT28MTsg9ngVmSBvql3Ms469wcK0wKwaaB0RJNBBPyhf1+VJJAWGAO+9Z0zzEpXM2+T9bRJJnrygd12Gz78oAaEZJkW933L/FbuTmV2lbCxwqDREMp8a6/PydYJ7+orHT/68UoiuZiRSf5uTdefHXbNqvW7gUVARTTcnazHKQbPOf1YE77/LyvAJGLz4MDI2pUTm1q7Vy06BMJy+a6je++/96xmtb5hgZa37e8IVW9zxYbl5z32wAVuFYAIfupTd2wanuVEjJFeBI0VJ4wmv3QDXLFOUoO9EA3nf+5HrinGiNpKv/LRuKzlaJqUkGdM2vi5z+3/5SseSXmSYTOI4TIFuegUDFAo+vsvfXb5xZMaKEIDjj37sW7NeclxzdVLb/6Xe8vS3rLf68848+g990DD4Kk0a0CFhCuv/D/fveURt51Cahhd/9GQxKga6oCZ6AYTyCEQt9zyQIh9rgQZR1nVHAZWAAoWd9x5cSC++MXFzmlRUUIaqboJEUixkem7znvTgmWPLwisYCHDDN40O/O0fU47bR/U06ioQ9VgsQFAjnPO/9F3bnzaiu6AhlKCVY4CaNgOylDYgZRGygFIMis//an3A/7ihl63VhuZ76BHqUh4g8/vMRcrV6PM02iJpIicK7jaNl1FTmg5N2yeOb3vkhKF5zIkEV6/YhEAuhtYZQdJB4GWY3r//OtuXJGtK3hhrmAuFGA19vzeKxHWlQbCwUwUQYMnf+iAJCtTl+cAwC1h9Ck2N5SUnl12ETLefNClrmBinXwHNRAB0K10CoomAzxr9u59V++z79+VZPbo7Qk31O6OIZaypU/jdTPnz+i7skpzoQqeVXtUGgBTMQYDsb2UGuopzi2Aq/5+CLDIyi3Aa+MGbFss2OLEooW1XREf/+QNnqcrt2Js+Ei+Vw94AwBTXaiQYixQ5fC7DVNnzPn7/efhwye/86QPvamnCyb87J6Xrr761nvve3RzOct9piGQVUIz08nKkKGiPRfPNMbY2ah6mFW/o+IJjdyIgCPnHELM8JijW91dcwCUCwUgt1YDA8sev7ACblkyIEaLwaE6XFZdQaHXLxKMlF48JRAIisKkBx/Bg/Pv/exF/yvnHGMcGcybC7TfdBIYUBdo2iGoIYMY+zWBHUF3MMXQrKNdAESXVGc37u25l1SrK5EJV85PPvo3k7sxe+6ixCbCyyS546EpADCzDlPhjlYb9Y8UAPd6WH5k8Km9Kx3I9RtmoosmAky777JxUi9KoUozSFp+5aAUxx6wfDn9YRG2C391fhqaLoQAoT0fIAAwtp1sROhqNBmw/snfzh9qYfqsRVmJuTTfsrIDIDuuULx62Ebg7Ojvim4p5Ti0CWYwDgayvl5MQlH/HjjYN+XFlcsvzMSer/9S8hlQA7AUtsn0iEaj8aofvUMaFeFIdmyAwkMPw1BRGzhSnKTMmUUQycp1//bgBc2AU065tdLkwAp0qan2WzTtpfZ547RxTEq/qjS6HopucDqFxof+cmFK4fnlCxpYEQtzC+Y5MDc48LGTZ69eOZ8Zp515xw9ufdJCgyycDmsFeR0emIwZc2agWawAIHU6n/1q0Y7trOqXOMPQUG9Fa2ZfvXLBg4/i7p8+9sY9+9/xF90MVURRVeib84Vs02OY6hwu03DDdgIdSKCopqt3yFEE3HffZfsfeE3d934tQY7VP6yPQnLfecN3//isyATE2tR4RmnYOIh5+1yWMDVBBWOZh0gLdfOddf/Bs3m0tTt15YFNk8DJrxWurfQfdUhltWMoujYcuO/sRZd8wAz/+1fPfOGy6wbLncsq0ibVATfo5hHgSKBYB7cxE1ARMDQyX/laU0c94BCY5EgGuplnBZIGQIW4AeqmF+1upgLYAswRDQ4kjgQxW8Kg15jGiHdGok2ZezYnrMpoZmVKAYIKZ+nqNvhILF4XmqLDADoMtNr+ioCVwf8IL+WOseXW2qNUB+PR6jCadUiaRi7awpw4cucIr0ZagdDoU+qvAb0605f/L9P//wj/L3380dXXebJxAAAAAElFTkSuQmCC parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/empresa/redes: put: summary: Redes operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_empresa_redes_yml description: >- #### Endpoint: api/empresa/redes ##### Método: PUT **Descrição**: Este endpoint edita as redes sociais do provedor. | _**Campo**_ | _**Limite/Valor**_ | | --- | --- | | `id` | 11 caracteres | | `whatsapp` | 64 caracteres | | `facebook` | 64 caracteres | | `twitter` | 64 caracteres | | `tiktok` | 64 caracteres | | `instagram` | 64 caracteres | | `youtube` | 64 caracteres | | `telegram` | 64 caracteres | | `skype` | 64 caracteres | | `kwai` | 64 caracteres | | `linkedin` | 64 caracteres | | _**Observação**_ | | --- | | **id**: O ID do provedor é necessário para enviar as redes, sendo o padrão **0**. | | Todas as redes sociais são opcionais. | tags: - Empresa responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string dados: type: object properties: id: type: number whatsapp: type: string facebook: type: string twitter: type: string tiktok: type: string instagram: type: string youtube: type: string telegram: type: string skype: type: string kwai: type: string linkedin: type: string example: status: sucesso mensagem: Redes sociais atualizadas com sucesso dados: id: 0 whatsapp: '7781998769538' facebook: '@facebook' twitter: elonmusk tiktok: '@tiktok' instagram: '@instagram' youtube: meu canal telegram: '7781998769538' skype: '@skype' kwai: '@kwai' linkedin: '@linkdin' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/redes' /api/empresa/show: get: summary: Show operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_empresa_show_yml description: |- #### Endpoint: api/empresa/show/{uuid do empresa} ##### Método: GET **Descrição**: Retorna uma lista dos dados da empresa em formato JSON. tags: - Empresa responses: '200': description: '200' content: application/json: schema: type: object properties: id: type: string uuid_provedor: type: string nome: type: string endereco: type: string bairro: type: string cidade: type: string cidade_ibge: type: string estado: type: string fone: type: string site: type: string email: type: string cep: type: string cnpj: type: string responsavel: type: string token: type: string celular: type: string razao: type: string fax: type: string nextel: type: object zero_oito: type: string ie: type: string cargo: type: string fistel: type: string codigo_receita: type: string coordenadas: type: string idforn: type: string im: type: string twitter: type: string facebook: type: string instagram: type: string whatsapp: type: string tiktok: type: string linkedin: type: string youtube: type: string telegram: type: string skype: type: string kwai: type: string logomarca: type: string example: id: '0' uuid_provedor: EFCB761A-C78A-48F4-A708-05CBE959D828 nome: Empresa Teste API endereco: Rua Teste, 123 bairro: Centro cidade: São Paulo cidade_ibge: '3550308' estado: SP fone: (11) 1234-5678 site: http://www.example.com email: teste@example.com cep: 01234-567 cnpj: 12.345.678/0001-90 responsavel: Jose S token: '99431' celular: (11) 99999-9999 razao: Empresa de Teste LTDA fax: (11) 9876-5432 nextel: null zero_oito: 789 456-0123 ie: isento cargo: Gerente fistel: '123' codigo_receita: '1015' coordenadas: '-4.027433,-38.4649854' idforn: '2' im: '' twitter: elonmusk7 facebook: '@facebook7' instagram: '@instagram7' whatsapp: '7777' tiktok: '@tiktok7' linkedin: '@linkdin7' youtube: meu canal7 telegram: '77819987695387' skype: '@skype7' kwai: '@kwai7' logomarca: >- iVBORw0KGgoAAAANSUhEUgAAAEsAAABLCAIAAAC3LO29AAAVtElEQVR4nN17e5RdVZ3m9/32PvdWFalAzANIJSnDQ+xoI29oQMGG1nFQUBlUnFF7+aDlTQtCLwkQSaRZ09qtjCAirSBLtG2hw0MJrQM+YGQaoRUGIbwCJMG8ICSVVNU9Z+/fN3+cW0kglepbJeKs+a1auZW65+y9v/N7Pw4n7/51/BFJARCYAKNMAOiUtb+kAw5FABz5r8NsPDvEV//Q4yG3YVOgItgSCwdABwCYCQ6AMCQAAqAIjnuLcT2OPwCpCTjgUpczgQmKBhgS4UFmHp1wRIeBCSpM4zvzH5eHbnCokelUUhWCWVBLYcWUqWHqlJ3XrB3aPCD33VzJITAAA1ABhs73+KMiVATohMGDD73/hDd85YrjupswQAIJEC6vaGeeueSmm34j2zWnpmPzuJjI38/SOGBtY9DWn3Gv4LDAzbcv/uvDDgaBJPzrnc+sWrXmAyceslMvAhKBEnHpEzjiiCsVCzCZxsGYiSGsTVw32HLEoAS6OhMHRzCJSKIBLg8H/Gn6yb+eCuKpJ/DWoxcmTcsqFCpU7Aorb/3hwkP3E51uuPun6f0fvl6hpI9DSidmaczV7cyAAcyMGY2O0AEmERDNAYfN7d9w94//KqJ8+Nf4s6OvHdS0HAgmlQZYZf3H/qe/Q2a2RKZj3h4Zno0aBzwAodn7nvEjdMJIj9gEuEigEzNOyIgEwGkAIzY9/si50ZQY9z/w8xUn59wyi5SBDktZErojh448fDYYKQy2il/et25cPmNCPFQEVHD1ypWfue2WM6OK0KkFJ5jFRFfhm8447YgiuGS/+lUqMTPnHGPTMqHgFoRGFAurvvCle4lAQciXXHCk2apxHXZCCOmJlVdDTeLQA5F9iKEjM0NBCI5oZru+bvCSCw+hrAROeN/CtmYmEwzMFEwBKoSCmloKIEjCcNTbZvzhEQJmFotuJpCQUx2pvssyFAGT9K1vfi4wAdgwgKo1rfLYRLSQnA6kIAezrHI6oWeehVDBCeKk9x47vqNOCCAaiDk0W0IkioZZR+vYyEfplg49BLU3/vSnr0boCZSrkmgAENufMJOJ6YYbHyAKmEw44b17AoCMCLX16mjX8VLOyomPPwEA7psyqk7ucoBIgDXseRqABPo9v3gqq2ZdreHbHdHsnp//WhIAEkUTQgm6pE7OP0GEAqDigQdXSIiWyNzpnXTA+mftJE9qM2AXmACI8NGMZBaWLn2WVM5qr8FMiuzIpE488qY17/rZQyQiy9yZ/TYZZJB94qPvJKMxKiOlbgQzjXVjqgKAELZou7m7e0fmbeIIU84P/vpxAp5LdbpO7Tr92GP3EySCZmJIOUORAphGu4dSbm8hQJBHMqDOHgGM6asmiJAkYGtfeBFAiBpdvEbbTgDgfbNACkh1whBCoOoVRmGLmSFsXb8qQQZJ1lkmPGE9zGYxlxTQ1U1yTCEbIadnA4UYRrYm4Mqp1I4fkafcP3cG4PLkwPe+/1u0GTtiacYM+l+FDDjG2KHSA9lkQMwOAIQJojwUEczi6LbUg955zCFABgOBK6+6bVzHmzDC9mNz39YAdLrZ6jUAIJFUCGXtCXZ0Hpod8/aDiILMrQrLVwyP66C/Jw/NDCGEjpNDp0z0n979WwAEJTWLF4Mb5Q6EUYTdVfJtR9QyYnf9/EVX3/iOOK6rRz+10jZMGPPKtiyn66+/s11WYzj+PYdIBEwEsL0tNbMNI1JiH/nYFSzGV5d4FRDuSAl9y+KvtOb26NJVLq//fs7Z/yUSIqgRm1G7zfa9oad7A+HuyELOu5bV4LiON2GEIyVNIScRYXskhkSBHkB3ute+giVgpWa1I0/XnD2wU89KZIOnjAaQYC0ChVHZY0zLnlyYKzdi7zdeKhZBzdcGYVvxSOScJaFOW7HlB4Bl8xxaQApuJqtLvQ6jNW+++cVMyNiAP/Ho58EBi11NE9So2CxDauUYG9XuMzY2AQvxsWV4YXB6UrJO7fbvi/BlJGlrhAGDImo8MiE60XZ3CgBMdPczTv9qEoiEbAXQLFYjy1NBloWXQTBWPXH1A/d/lob1gzjyrQurpFjA9ZraUgDIOW+jimZsAgiROWwOzE1vdvmLRxzatctO62QVvAlWZEjYffbs+SlFGnJMv3vu8rf8ybocV5BdNG/ihRuuffczyxY1DItv37THG65KNrupyKrIfM0rwiltYwBlQmIYTHmwgfKaq897z3E9RXC63XLbyo+eepvYDkTcMFz29+110fKnFwbEAPzsrnMzGBAAUMgZv/j55o9+5G8HqtmVx4CNxh6xJXWjs2Tt90JI1cYdEnxrYuHkUODAnP6ezy84/7hjLFgCUgKz44orbwaaoEMG5pxl0QaGZvbNXXDRee8+7dSDksdmgAQBK1fjHcdfunrNlOw7B1vfZDJW0mAmItcjTxGi18kK3eljlPonWBEOxLCn7rhq3fIFc15/7nAZP3jSWy+//Pi6Yg1DRnaEZ5/Gd2588KqrF1c+BbbTdumOQ9HpBlgqGVqyDAtqhVgMfukrJ37o/ftEAXXlzSDACTmS4/CjLn/q6UlEF5l9zNxtgggZm/IXvvb3//XDJ07JoYF2TozkWLDgjm/f8MtWOdmxM1h5ZkLMlhsRTNs/aYci4QAyDWxNn7z+0Ufnx7oUiwRFQYCPuF2DACQxVsBuMy+hvT7nrB0HVRNCKMusZvRuevyxz0ZHy1BVOOOsf7r19kdynuboRUhSDh5J1nmqBTezLUn61u0FwMTkKMxf2nmnDcueuDRYAqIwTHW1HwNrd2QUJGSrIgogPfO7eOAhX880pR0GVRNBSDljZu4xrM1Ezt20JuUjltkdMotZbX8vceTzZU/aATrNKvcGOfjcU2ft3AWYQwKCA0kwYenjeOS3GwcHh/fee8rBhxaBCEJ2BaOIt73jfzz8aI/yDssoE5RSi83c2syGlcrdalZWIYetIuiZwUimNiIDHKPaAxljZLXuuWXn9dYMIyC0Ksyee8Gwz3HEwoqcs5nllCiPcXD18nOLgMwUhBJxt74vZEzf4VEnAA9AapVBxpybuckUDAyCw9xajbh2v32bx71zbm69ZE46DckwSq2BAlimcmCvN+TeJsCUXQK+ft1TM+deVmIPohlZJJSInlBaCLKQsUv/Gy4QIBCKAdhjboRsR5XFiVoaQYQDypWxkZyxWL/4n0897OBJzQAXgmHFWhx40D8OVR7BbElAkFMN0R1mAuEwfuLjf3L5wiOLDIUExDfvt2j5mskMXUwOFbJqFDaoeuSh02dNy0DIxAP3V39x/LfdhomGeRbNYYat8jN+kmXC6VGJDEV44eQTpm5Y8dmjDp30t5fdNW3WP0zv+9rM2Qt2m47sRkqgyTjyYChAhdNFD1zzxYVHFnIFJI8nnvytlWunwqYQBQDZKJ7dATCc8skbQMpdyPsdUEAlGbepoG7l54Q8PttK5bSgcskP/+aA/bCphdlz50t7yiY5fVgRDhmN8CxDXaEwwIAMVnXL/qqvfpzZ6/Dhe//8xE/v2eRswHNmK9ShD5O9MmUBYPf/2+OS0UAkIyyoNjUa0fktSjERHlJAqhJEG1638owD3oJvXvfMzFlXELPJQXMi5Mzex5Yi5eGqatXZRlts2BJh8Khgee2Jx++ukMlQlTjrMz8pU5flYBoODjFBhtFyJSK4heTt+jIEqGKdX7PuUm69eCI8FNHVnEw9+uyyyxEwq/+ioTTHiijJEWUp5gbVOPyYayMikcyDrG6IuwiHRUPIA7cvudAsEwWEOXtf1EozuyI91zmWAUZ4ELYvw0lytEEYLAOmWg9yO3vexi1NgIfusCq/9OzSy7uJU069abDshywrCAURTS66m6c6M7TmiLdI7cQKTO4hbNhvf8gDHAkYTJMbxuxUGAbMYY4AOEepa0DIZACxxYQ6zN1HrTZ0iNDrZ+NqZQXm8qH7z+7qxvcWr7j5llUpl0IOJJjB3JYLWTM3RXcIrO2h1e0XQwWEJUsWNJGMAHHxJT8WJ7mCzKECgMENWTTnKFImU5BHtic5HEAIpLYV1C3UkZRmRjJFB9ADW/e+4/edMxP/7WM33n5XWXloxqasekVUXfeYpG5nZawnt0IdvRIefPhNbwYVBSXn1dc+KJvWCFVWIXTS5GkcddQ8oU69seTO51NyszhSJn4ZdcRDCiYI5sxNbrjma++qHHcsWZdVScxe5u2CJhHJvDIX69g6mVBbOcGKsCnUJX3yth+uzJgiyR0d1uzk+YMfPJoEYC4svuXeGBuSRr29I4RBoJAJWnruucuCY9dZ81PRW3hqhOxs2Pb5i2JTjaa8aYxEqbUKrbY5VZwzx9vOADr73K8kKKiUig7rruY64fgZgkg6sfj2f99OCW2U33ZE3v7HACy68LAA/OphKPQJw0QhNWGtUaSdSfGl6VPW3vaDv1qz8pMvPX/RsYd1U7Fe74wzT6o3N3Bg0y5kMI/Z8thdpK2H5guFuYkS7vvlgKN/jIs70EO6FMFkrM781AEV8e73np/TnsYis/K6t/IyHjo5FLlx8fcuPvhwNpCImIHfPPwsNBuE0w/af6/sw7SmQRnd9aQNage4/f6C6E5scf1/um8PkSWD+fkXfCOnXgtb1KRuwm11GB10iWXyJAz/+VtnMGD/gy6uyr0MgZ7gwZHJoOySkju08RMn961b8derVlxy2OH8h//+i+VPRRckrN/Yl00OC0j77I1gXWxP2PQGoAop5MKtHP0hK0ImNyJUGvyfS87Oua4k2NKnG0QeiZZG4HCcUZvcgj3/T985J2WsfH6WEABlFrIsl3myRnn4IX033fQBA5ixdg3ed/zCR5a97rj/POO888VMCVkOBpOBdcs4EVGAkMUIOliZN16pirJsyeTBmzQXhveaXZEgCwjf/MZzRI/HNFrDYzwIQwhf/uLZRcDXrnrSLWZlWgWIYg/94EMm/eO1p+8+DXQk4JTTv7v49hdSnuJWfPWqk0yggQkhFK4EAggAlI0GEtGqSmHrIPAo++d61GjYqx576Z67LjS40SDMX3BD0jQLedS23HgQFq2PfLjPhfmLbgo2RaR57Ak45tje6795cjBAWL8Re867EDa1avVa0SNL3eG5qd341nUPfORjB65dX1dyI+VifPJpzNvLILny1Cmr1q7dJ4dWthTcX6k4dMtG9IhVtPDMkxf2RmWZ6E8+ba0wPchSidHigjZ1ZLtmTFtHx4svIaNXlZiAXH73+6d847oPgrj+u0un91+0x7yrzfbJrckWqqAUmZc+sqgqce6FPzDHhpegumaGCOCcz1yZCdDh4de/WdSMK4KSRr59BZEBYVjafOfiv+ztASKJtH6jHfn2L9MFmcJYKMb4bksC4gsXfoKGs8/6NtRgMAuQFZ8+9Yplz9m8N1961md+MpT28MTsg9ngVmSBvql3Ms469wcK0wKwaaB0RJNBBPyhf1+VJJAWGAO+9Z0zzEpXM2+T9bRJJnrygd12Gz78oAaEZJkW933L/FbuTmV2lbCxwqDREMp8a6/PydYJ7+orHT/68UoiuZiRSf5uTdefHXbNqvW7gUVARTTcnazHKQbPOf1YE77/LyvAJGLz4MDI2pUTm1q7Vy06BMJy+a6je++/96xmtb5hgZa37e8IVW9zxYbl5z32wAVuFYAIfupTd2wanuVEjJFeBI0VJ4wmv3QDXLFOUoO9EA3nf+5HrinGiNpKv/LRuKzlaJqUkGdM2vi5z+3/5SseSXmSYTOI4TIFuegUDFAo+vsvfXb5xZMaKEIDjj37sW7NeclxzdVLb/6Xe8vS3rLf68848+g990DD4Kk0a0CFhCuv/D/fveURt51Cahhd/9GQxKga6oCZ6AYTyCEQt9zyQIh9rgQZR1nVHAZWAAoWd9x5cSC++MXFzmlRUUIaqboJEUixkem7znvTgmWPLwisYCHDDN40O/O0fU47bR/U06ioQ9VgsQFAjnPO/9F3bnzaiu6AhlKCVY4CaNgOylDYgZRGygFIMis//an3A/7ihl63VhuZ76BHqUh4g8/vMRcrV6PM02iJpIicK7jaNl1FTmg5N2yeOb3vkhKF5zIkEV6/YhEAuhtYZQdJB4GWY3r//OtuXJGtK3hhrmAuFGA19vzeKxHWlQbCwUwUQYMnf+iAJCtTl+cAwC1h9Ck2N5SUnl12ETLefNClrmBinXwHNRAB0K10CoomAzxr9u59V++z79+VZPbo7Qk31O6OIZaypU/jdTPnz+i7skpzoQqeVXtUGgBTMQYDsb2UGuopzi2Aq/5+CLDIyi3Aa+MGbFss2OLEooW1XREf/+QNnqcrt2Js+Ei+Vw94AwBTXaiQYixQ5fC7DVNnzPn7/efhwye/86QPvamnCyb87J6Xrr761nvve3RzOct9piGQVUIz08nKkKGiPRfPNMbY2ah6mFW/o+IJjdyIgCPnHELM8JijW91dcwCUCwUgt1YDA8sev7ACblkyIEaLwaE6XFZdQaHXLxKMlF48JRAIisKkBx/Bg/Pv/exF/yvnHGMcGcybC7TfdBIYUBdo2iGoIYMY+zWBHUF3MMXQrKNdAESXVGc37u25l1SrK5EJV85PPvo3k7sxe+6ixCbCyyS546EpADCzDlPhjlYb9Y8UAPd6WH5k8Km9Kx3I9RtmoosmAky777JxUi9KoUozSFp+5aAUxx6wfDn9YRG2C391fhqaLoQAoT0fIAAwtp1sROhqNBmw/snfzh9qYfqsRVmJuTTfsrIDIDuuULx62Ebg7Ojvim4p5Ti0CWYwDgayvl5MQlH/HjjYN+XFlcsvzMSer/9S8hlQA7AUtsn0iEaj8aofvUMaFeFIdmyAwkMPw1BRGzhSnKTMmUUQycp1//bgBc2AU065tdLkwAp0qan2WzTtpfZ547RxTEq/qjS6HopucDqFxof+cmFK4fnlCxpYEQtzC+Y5MDc48LGTZ69eOZ8Zp515xw9ufdJCgyycDmsFeR0emIwZc2agWawAIHU6n/1q0Y7trOqXOMPQUG9Fa2ZfvXLBg4/i7p8+9sY9+9/xF90MVURRVeib84Vs02OY6hwu03DDdgIdSKCopqt3yFEE3HffZfsfeE3d934tQY7VP6yPQnLfecN3//isyATE2tR4RmnYOIh5+1yWMDVBBWOZh0gLdfOddf/Bs3m0tTt15YFNk8DJrxWurfQfdUhltWMoujYcuO/sRZd8wAz/+1fPfOGy6wbLncsq0ibVATfo5hHgSKBYB7cxE1ARMDQyX/laU0c94BCY5EgGuplnBZIGQIW4AeqmF+1upgLYAswRDQ4kjgQxW8Kg15jGiHdGok2ZezYnrMpoZmVKAYIKZ+nqNvhILF4XmqLDADoMtNr+ioCVwf8IL+WOseXW2qNUB+PR6jCadUiaRi7awpw4cucIr0ZagdDoU+qvAb0605f/L9P//wj/L3380dXXebJxAAAAAElFTkSuQmCC parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/fornecedores/editar: put: summary: Editar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_fornecedores_editar_yml description: >- #### Endpoint: api/fornecedores/editar ##### Método: PUT **Descrição**: Editar dados do fornecedor no sistema, passando o **UUID** no corpo da requisição. | **Campo** _**/**_ `Observação` | _**Limite/Valor**_ | | --- | --- | | `uuid`: UUID do fornecedor a ser editado. | 64 caracteres | | `razaosoc`: Nome ou Razão Social do fornecedor. | 255 caracteres | | `nomefan`: Apelido ou Nome Fantasia do fornecedor. | 255 caracteres | | `email`: Endereço de e-mail do fornecedor. | 100 caracteres | | `contato`: Nome do contato. | 255 caracteres | | `cpf_cnpj`: CPF ou CNPJ. | 30 caracteres | | `rg_ie`: RG/IE do fornecedor | 30 caracteres | | `tipo`: Sobre o tipo de pessoa, defina como **física** ou **juridica**. | **fisica** / **juridica** | | `endereco`: Endereço do fornecedor. | 255 caracteres | | `bairro`: Bairro do fornecedor. | 255 caracteres | | `numero`: Número de endereço do fornecedor. | 50 caracteres | | `complemento`: Informações adicionais para o endereço. | 255 caracteres | | `cep`: CEP do endereco do fornecedor. | 11 caracteres | | `cidade`: Cidade do fornecedor. | 255 caracteres | | `estado`: Estado do fornecedor. | 255 caracteres | | `telefone`: Número de telefone do fornecedor. | 50 caracteres | | `celular`: Número de celular do fornecedor. | 50 caracteres | | `fax`: Fax do fornecedor | 50 caracteres | | `crc`: CRC do contador | 30 caracteres | | `obs`: Comentário ou observação sobre o fornecedor. | LONGTEXT | tags: - Fornecedores responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Fornecedor editado com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/editar' /api/fornecedores/inserir: post: summary: Inserir operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_fornecedores_inserir_yml description: >- #### Endpoint: api/fornecedores/inserir ##### Método: POST **Descrição**: Inserir um novo fornecedor no sistema. | **Campo** _**/**_ `Observação` | _**Limite/Valor**_ | | --- | --- | | `razaosoc`: Nome ou Razão Social do fornecedor. | 255 caracteres | | `nomefan`: Apelido ou Nome Fantasia do fornecedor. | 255 caracteres | | `email`: Endereço de e-mail do fornecedor. | 100 caracteres | | `contato`: Nome do contato. | 255 caracteres | | `cpf_cnpj`: CPF ou CNPJ. | 30 caracteres | | `rg_ie`: RG/IE do fornecedor | 30 caracteres | | `tipo`: Sobre o tipo de pessoa, defina como **física** ou **juridica**. | fisica / juridica | | `endereco`: Endereço do fornecedor. | 255 caracteres | | `bairro`: Bairro do fornecedor. | 255 caracteres | | `numero`: Número de endereço do fornecedor. | 50 caracteres | | `complemento`: Informações adicionais para o endereço. | 255 caracteres | | `cep`: CEP do endereco do fornecedor. | 11 caracteres | | `cidade`: Cidade do fornecedor. | 255 caracteres | | `estado`: Estado do fornecedor. | 255 caracteres | | `telefone`: Número de telefone do fornecedor. | 50 caracteres | | `celular`: Número de celular do fornecedor. | 50 caracteres | | `fax`: Fax do fornecedor | 50 caracteres | | `crc`: CRC do contador | 30 caracteres | | `obs`: Comentário ou observação sobre o fornecedor. | LONGTEXT | tags: - Fornecedores responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Fornecedor inserido com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/inserir' /api/fornecedores/listar/pagina=1: get: summary: Listar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_fornecedores_listar_yml description: >- #### Endpoint: api/fornecedores/listar ##### Método: GET **Descrição**: Retorna uma lista de fornecedores no formato JSON. **Paginação** A paginação é iniciada na página 1 por padrão. Para navegar entre os registros, o total de páginas é incluído no corpo da resposta, auxiliando na navegação. | Parâmetros de consulta | Descrição | Exemplo | | --- | --- | --- | | `pagina:` | Paginação para navegar entre os registros.(pagina padrão 1). | /listar/pagina=2 | | `limite:` | Quantidade de registros que serão retornados (limite maximo 500 padrão) _parâmetro opcional_ | /listar/pagina=9&limite=150 | **Filtro para consulta** Este endpoint aceita parâmetros para filtrar os resultados. Após api/fornecedores/listar, adicione uma barra **`/`** e os parâmetros desejados. | Observação | Exemplo | | --- | --- | | Todos os parâmetros retornados na resposta **"fornecedores":** deste endpoint podem ser utilizados para filtrar os resultados da consulta, separando-os com **`&`**. | listar/tipo=juridica | tags: - Fornecedores responses: '200': description: '' content: application/json: schema: type: object properties: total_registros: type: number consulta_atual: type: number pagina_atual: type: number total_paginas: type: number fornecedores: type: array items: type: string properties: '0': type: object properties: uuid: type: string razaosoc: type: string nomefan: type: string contato: type: string email: type: string cpf_cnpj: type: string rg_ie: type: string tipo: type: string endereco: type: object numero: type: object bairro: type: object cidade: type: object estado: type: string complemento: type: object telefone: type: object celular: type: object fax: type: object cep: type: object crc: type: object obs: type: object '1': type: object properties: uuid: type: string razaosoc: type: string nomefan: type: string contato: type: string email: type: string cpf_cnpj: type: string rg_ie: type: string tipo: type: string endereco: type: string numero: type: string bairro: type: string cidade: type: string estado: type: string complemento: type: string telefone: type: object celular: type: string fax: type: string cep: type: string crc: type: object obs: type: object '2': type: object properties: uuid: type: string razaosoc: type: string nomefan: type: string contato: type: string email: type: string cpf_cnpj: type: string rg_ie: type: string tipo: type: string endereco: type: string numero: type: string bairro: type: string cidade: type: string estado: type: string complemento: type: string telefone: type: string celular: type: string fax: type: object cep: type: string crc: type: string obs: type: object '3': type: object properties: uuid: type: string razaosoc: type: string nomefan: type: string contato: type: string email: type: string cpf_cnpj: type: string rg_ie: type: string tipo: type: string endereco: type: string numero: type: string bairro: type: string cidade: type: string estado: type: string complemento: type: string telefone: type: string celular: type: string fax: type: string cep: type: string crc: type: string obs: type: string example: total_registros: 4 consulta_atual: 4 pagina_atual: 1 total_paginas: 1 fornecedores: - uuid: c6a0a006-7ac1-11ee-961c-080027c29949 razaosoc: Empressa para testes nomefan: Empressa Teste contato: Jose santos email: fornecedor@gmail.com cpf_cnpj: '8884344285' rg_ie: '070707' tipo: fisica endereco: null numero: null bairro: null cidade: null estado: AC complemento: null telefone: null celular: null fax: null cep: null crc: null obs: null - uuid: 4DB260E7-A31D-480E-B1DB-F542B1718669 razaosoc: SoluçõesTech Comércio e Serviços Ltda nomefan: TecnoSupplies contato: Marina Almeida email: info@imaginetech.com cpf_cnpj: 44.203.984/0001-83 rg_ie: 11.334.587-2 tipo: juridica endereco: Rua Acre 2 numero: '404' bairro: Aeroporto Velho cidade: Rio Branco estado: AC complemento: Casa amarela telefone: null celular: (00)900001111 fax: (00)9999-0000 cep: 69911-087 crc: null obs: null - uuid: D09FB1D8-4954-4127-B943-816BA88F1EEE razaosoc: TechNet Soluções em Conectividade Ltda. nomefan: TechNet Solutions contato: Luciana Hadassa da Paz email: technet.ltda@gmil.com cpf_cnpj: 71.172.542/0001-90 rg_ie: 35.815.094-2 tipo: juridica endereco: Rua Lucrécio Avelino numero: '656' bairro: Água Mineral cidade: Teresina estado: PI complemento: Centro telefone: (89)8888-8888 celular: (77)944448888 fax: null cep: 64007-500 crc: '12345' obs: null - uuid: 314c4375-9eb0-11ee-98b5-080027c29949 razaosoc: TechNet Soluções em Conectividade Ltda. nomefan: TechNet Solutions contato: Luciana Hadassa da Paz email: tech.net.ltda@gmil.com cpf_cnpj: 71.172.542/0001-90 rg_ie: 35.815.094-2 tipo: juridica endereco: Rua Lucrécio Avelino numero: '656' bairro: Água Mineral cidade: Teresina estado: PI complemento: Centro telefone: (89)8888-8888 celular: (77)944448888 fax: '' cep: 64007-500 crc: '123' obs: >- Fornecimento de equipamentos essenciais para operação de estações de rádio parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/fornecedores/69AC9470-2C8F-4D9F-BC1A-7F64F422F433: delete: summary: Remover operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_fornecedores_remover_yml description: >- #### Endpoint: api/fornecedores/{uuid do fornecedor} ##### Método: DELETE **Descrição**: Exclui um fornecedor do sistema ao passar o número do chamado na URL. tags: - Fornecedores responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Registro excluido com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/fornecedores/show/4DB260E7-A31D-480E-B1DB-F542B1718669: get: summary: Show operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_fornecedores_show_yml description: >- #### Endpoint: api/fornecedores/show/{uuid do fornecedor} ##### Método: GET **Descrição**: Retorna os detalhes de um fornecedor específico em formato JSON. tags: - Fornecedores responses: '200': description: '200' content: application/json: schema: type: object properties: id: type: string uuid_fornecedor: type: string razaosoc: type: string nomefan: type: string contato: type: string endereco: type: string numero: type: string bairro: type: string cidade: type: string estado: type: string complemento: type: string telefone: type: object celular: type: string nextel: type: object fax: type: string email: type: string cpf_cnpj: type: string rg_ie: type: string tipo: type: string cep: type: string obs: type: object crc: type: object example: id: '1' uuid_fornecedor: 4DB260E7-A31D-480E-B1DB-F542B1718669 razaosoc: SoluçõesTech Comércio e Serviços Ltda nomefan: TecnoSupplies contato: Marina Almeida endereco: Rua Acre 2 numero: '404' bairro: Aeroporto Velho cidade: Rio Branco estado: AC complemento: Casa amarela telefone: null celular: (00)900001111 nextel: null fax: (00)9999-0000 email: info@imaginetech.com cpf_cnpj: 44.203.984/0001-83 rg_ie: 11.334.587-2 tipo: juridica cep: 69911-087 obs: null crc: null parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/funcionarios/editar: put: summary: Editar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_funcionarios_editar_yml description: >- #### Endpoint: api/funcionarios/editar ##### Método: POST **Descrição**: Editar | **Campo** _**/**_ `Observação` | _**Limite/Valor**_ | | --- | --- | | `uuid`: UUID necessário para editar o funcionário. | 48 caracteres | | `nome`: Nome completo do funcionário. | 255 caracteres | | `cpf`**:** CPF do funcionário. | 20 caracteres | | `rg`**:** RG do funcionário. | 20 caracteres | | `nascimento`: Data de nascimento do funcionário. | 20 caracteres | | `email`: Endereço de e-mail do funcionário. | 50 caracteres | | `cargo`: Ocupação do funcionário na empresa. | 50 caracteres | | `sexo`: Sexo do funcionário. | **f** / **m** | | `telefone`: Número de telefone do funcionário. | 20 caracteres | | `celular`: Número de celular do funcionário. | 20 caracteres | | `endereco`: Endereço do funcionário. | 255 caracteres | | `numero`: Número do endereço funcionário. | 20 caracteres | | `bairro`: Bairro do funcionário. | 255 caracteres | | `cidade`: Cidade do funcionário. | 255 caracteres | | `estado`: Estado do funcionário. | 2 caracteres | | `cep`: CEP do funcionário. | 11 caracteres | | `complemento`: Informações adicionais para o endereço. | 255 caracteres | | `cidade_ibge`: IBGE da cidade. | 16 caracteres | | `salario`**:** Salário do funcionário. | 12,2 / DECIMAL | | `data_adm`: Data de contratação do funcionário. | 11 caracteres | | `comissao`: Comissão do funcionário. | 12,2 / DECIMAL | | `tipo`: Se o funcionário é **interno** (**i**) ou terceirizado(**t**). | **i** / **t** | | `crc`: Conselho Regional de Contabilidade (CRC). | 30 caracteres | tags: - Funcionarios responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Funcionario editado com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/editar' /api/funcionarios/inserir: post: summary: Inserir operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_funcionarios_inserir_yml description: >- #### Endpoint: api/funcionarios/inserir ##### Método: POST **Descrição**: Inserir um novo funcionário no sistema. | **Campo** _**/**_ `Observação` | _**Limite/Valor**_ | | --- | --- | | `nome`: Nome completo do funcionário. | 255 caracteres | | `cpf`**:** CPF do funcionário. | 20 caracteres | | `rg`**:** RG do funcionário. | 20 caracteres | | `nascimento`: Data de nascimento do funcionário. | 20 caracteres | | `email`: Endereço de e-mail do funcionário. | 50 caracteres | | `cargo`: Ocupação do funcionário na empresa. | 50 caracteres | | `sexo`: Sexo do funcionário. | **f** / **m** | | `telefone`: Número de telefone do funcionário. | 20 caracteres | | `celular`: Número de celular do funcionário. | 20 caracteres | | `endereco`: Endereço do funcionário. | 255 caracteres | | `numero`: Número do endereço funcionário. | 20 caracteres | | `bairro`: Bairro do funcionário. | 255 caracteres | | `cidade`: Cidade do funcionário. | 255 caracteres | | `estado`: Estado do funcionário. | 2 caracteres | | `cep`: CEP do funcionário. | 11 caracteres | | `complemento`: Informações adicionais para o endereço. | 255 caracteres | | `cidade_ibge`: IBGE da cidade. | 16 caracteres | | `salario`**:** Salário do funcionário. | 12,2 / DECIMAL | | `data_adm`: Data de contratação do funcionário. | 11 caracteres | | `comissao`: Comissão do funcionário. | 12,2 / DECIMAL | | `tipo`: Se o funcionário é **interno** (**i**) ou terceirizado(**t**). | **i** / **t** | | `crc`: Conselho Regional de Contabilidade (CRC). | 30 caracteres | tags: - Funcionarios responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string dados: type: object properties: nome: type: string cpf: type: string rg: type: string nascimento: type: string email: type: string cargo: type: string sexo: type: string telefone: type: string celular: type: string endereco: type: string numero: type: string bairro: type: string cidade: type: string estado: type: string cep: type: string complemento: type: string cidade_ibge: type: string salario: type: number data_adm: type: string comissao: type: number tipo: type: string crc: type: string example: status: sucesso dados: nome: Isabela Esther Jéssica Fernandes cpf: 072.548.787-99 rg: 38.305.379-1 nascimento: '1996-02-26' email: isabela-fernandes98@live.jp cargo: Atendente sexo: f telefone: '' celular: (27) 98114-4954 endereco: Rua Otávio Carneiro numero: '614' bairro: Pedra dos Búzios cidade: Vila Velha estado: ES cep: 29121-285 complemento: Casa 2 andar azul cidade_ibge: '3205200' salario: 1320 data_adm: '2023-12-07' comissao: 10 tipo: i crc: '' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/inserir' /api/funcionarios/listar/pagina=1: get: summary: Listar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_funcionarios_listar_yml description: >- #### Endpoint: api/funcionarios/listar ##### Método: GET **Descrição**: Retorna uma lista de funcionarios no formato JSON. **Paginação** A paginação é iniciada na página 1 por padrão. Para navegar entre os registros, o total de páginas é incluído no corpo da resposta, auxiliando na navegação. | Parâmetros de consulta | Descrição | Exemplo | | --- | --- | --- | | `pagina:` | Paginação para navegar entre os registros.(pagina padrão 1). | /listar/pagina=2 | | `limite:` | Quantidade de registros que serão retornados (limite maximo 500 padrão) _parâmetro opcional_ | /listar/pagina=9&limite=150 | **Filtro para consulta** Este endpoint aceita parâmetros para filtrar os resultados. Após api/funcionarios/listar, adicione uma barra **`/`** e os parâmetros desejados. | Observação | Exemplo | | --- | --- | | Todos os parâmetros retornados na resposta **"funcionarios":** deste endpoint podem ser utilizados para filtrar os resultados da consulta, separando-os com **`&`**. | listar/nome=Marie | tags: - Funcionarios responses: '200': description: '' content: application/json: schema: type: object properties: total_registros: type: number consulta_atual: type: number pagina_atual: type: number total_paginas: type: number funcionarios: type: array items: type: string properties: '0': type: object properties: uuid_func: type: string nome: type: string cpf: type: string nascimento: type: string email: type: string telefone: type: object celular: type: string salario: type: string '1': type: object properties: uuid_func: type: string nome: type: string cpf: type: string nascimento: type: string email: type: string telefone: type: object celular: type: string salario: type: string '2': type: object properties: uuid_func: type: string nome: type: string cpf: type: string nascimento: type: string email: type: string telefone: type: string celular: type: string salario: type: string example: total_registros: 3 consulta_atual: 3 pagina_atual: 1 total_paginas: 1 funcionarios: - uuid_func: 995b1afd-9f6c-11ee-9f70-080027c29949 nome: Isabele Esther Jéssica Fernandes cpf: 072.548.787-99 nascimento: '1996-02-26' email: isabele-fernandes98@live.jp telefone: null celular: (27) 98114-4954 salario: '1320.00' - uuid_func: F0683970-16E4-4166-A47B-699920913DF2 nome: Jose Santos cpf: 136.710.888-85 nascimento: '1998-01-23' email: joseapi7teste@gmail.com telefone: null celular: (63)991706544 salario: '0.00' - uuid_func: D6162A99-3569-45CC-B378-CFBCF8AF667D nome: Marie Curie cpf: 939.871.410-85 nascimento: '1867-11-07' email: Marie1867@gmail.com telefone: (77)9876-8786 celular: (77)9786777 salario: '1320.00' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/funcionarios/d3d8cab4-9f6f-11ee-9f70-080027c29949: delete: summary: Remover operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_funcionarios_remover_yml description: >- #### Endpoint: api/funcionarios/{uuid do funcionario} ##### Método: DELETE **Descrição**: Deleta um funcionário específico passando o UUID no parâmetro da URL. tags: - Funcionarios responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Registro excluido com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/funcionarios/show/D6162A99-3569-45CC-B378-CFBCF8AF667D: get: summary: Show operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_funcionarios_show_yml description: >- #### Endpoint: api/funcionarios/show/(uuid do funcionário) ##### Método: GET **Descrição**: Retorna os detalhes de um funcionários específico em formato JSON. tags: - Funcionarios responses: '200': description: '200' content: application/json: schema: type: object properties: id: type: string uuid_func: type: string nome: type: string sexo: type: string nascimento: type: string telefone: type: string celular: type: string nextel: type: object cpf: type: string rg: type: string email: type: string cep: type: string endereco: type: string numero: type: string complemento: type: string estado: type: string cidade: type: string data_adm: type: string salario: type: string cargo: type: string comissao: type: string bairro: type: string tipo: type: string crc: type: string cidade_ibge: type: string example: id: '2' uuid_func: D6162A99-3569-45CC-B378-CFBCF8AF667D nome: Marie Curie sexo: f nascimento: '1867-11-07' telefone: (77)9876-8786 celular: (77)9786777 nextel: null cpf: 939.871.410-85 rg: '35434' email: Marie1867@gmail.com cep: 60711-055 endereco: Rua Francisco Glicério numero: '404' complemento: até 1468/1469 estado: CE cidade: Fortaleza data_adm: '2023-07-28' salario: '1320.00' cargo: Contadora comissao: '7.00' bairro: Maraponga tipo: i crc: 1SP111111/O-1 cidade_ibge: '2304400' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/mensagem/enviar_email: post: summary: Enviar_email operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_mensagem_enviar_email_yml description: >- #### Endpoint: api/mensagem/enviar_email ##### Método: POST **Descrição**: Endpoint usado para enviar mensagens para o email do cliente. | _**Campo**_ | _**Limite/Tipo**_ | | --- | --- | | `login` | 64 caracteres | | `assunto` | LONGTEXT | | `mensagem` | LONGTEXT | | _**Observação**_ | | --- | | **login**: Login do cliente que receberá a mensagem. | | **assunto**: Assunto da mensagem a ser enviada. | | **mensagem**: Conteúdo da mensagem a ser enviada. | tags: - Mensagem responses: '200': description: '' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Email enviado com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/enviar_email' /api/mensagem/enviar_sms: post: summary: Enviar_sms operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_mensagem_enviar_sms_yml description: >- #### Endpoint: api/mensagem/enviar_sms ##### Método: POST **Descrição**: Endpoint utilizado para enviar mensagens via SMS para o celular do cliente. | _**Campo**_ | _**Limite/Tipo**_ | | --- | --- | | `login` | 64 caracteres | | `mensagem` | LONGTEXT | | _**Observação**_ | | --- | | **login**: Login do cliente que receberá a mensagem. | | **mensagem**: Conteúdo da mensagem a ser enviada. | tags: - Mensagem responses: '200': description: '' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: SMS enviado com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/enviar_sms' /api/mensagem/enviar_zap: post: summary: Enviar_zap operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_mensagem_enviar_zap_yml description: >- #### Endpoint: api/mensagem/enviar_zap ##### Método: POST **Descrição**: Endpoint utilizado para enviar mensagens via WhatsApp. | _**Campo**_ | _**Limite/Tipo**_ | | --- | --- | | `tipo` | 1, 2, 3 | | `login` | 64 caracteres | | `mensagem` | LONGTEXT | | _**Observação**_ | | --- | | **tipo**: Para o envio de texto, utilize o tipo 1. | | **login**: Login do cliente que receberá a mensagem. | | **mensagem**: Conteúdo da mensagem a ser enviada. | ##### O endpoint /api/mensagem/enviar_zap é utilizado para enviar mensagens para o WhatsApp. ##### Abaixo estão exemplos utilizando o mesmo endpoint com diferentes tipos de mensagens, mudando apenas o corpo da requisição. tags: - Mensagem responses: '200': description: '' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Zap enviado com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/enviar_zap' /api/instalacao/editar: put: summary: Editar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_instalacao_editar_yml description: >- #### Endpoint: api/instalacao/editar ##### Método: PUT **Descrição**: Altera a instalação no sistema. | **Campo** _**/**_ `Observação` | _**Limite/Valor**_ | | --- | --- | | `uuid` | 64 caracteres | | `nome`: Nome completo do cliente **\[campo obrigatório: sim\]** | 255 caracteres | | `Login`: Login do usuário. **\[campo obrigatório: sim\]** | 64 caracteres | | `senha`: Senha de acesso do cliente **\[campo obrigatório: sim\]** | 32 caracteres | | `email`: Endereço de e-mail para o envio de faturas, avisos, etc. | 255 caracteres | | `cpf`**:** CPF ou CNPJ com ou sem pontuação **\[campo obrigatório: sim\]** | 20 caracteres | | `rg`: Rg do cliente com ou sem pontuação | 255 caracteres | | `data_nasc`: Data de nascimento no formato dd/mm/aaaa. | 20 caracteres | | `endereco`: Endereço do cliente. | 255 caracteres | | `bairro`: Bairro do cliente. | 255 caracteres | | `numero`: Número do endereço. | 20 caracteres | | `complemento`: Informações adicionais para o endereço. | 255 caracteres | | `cep`: CEP do cliente. | 20 caracteres | | `cidade`: Cidade do cliente. | 255 caracteres | | `estado`: Estado do cliente. | 10 caracteres | | `telefone`: Número de telefone do cliente. | 255 caracteres | | `celular`: Número de celular do cliente. | 50 caracteres | tags: - Instalacao responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string dados: type: object properties: nome: type: string login: type: string senha: type: string email: type: string cpf: type: string rg: type: string data_nasc: type: string endereco: type: string bairro: type: string numero: type: string complemento: type: string cep: type: string cidade: type: string estado: type: string telefone: type: string celular: type: string example: status: sucesso mensagem: Registro inserido com sucesso dados: nome: Elisa Caroline Gonçalves login: elisa senha: '123' email: elisacarolinegoncalves@outloock.com.br cpf: 455.717.141-90 rg: 37.783.633-3 data_nasc: '1997-02-17' endereco: Rua Pêssego bairro: Morada do Sol numero: '404' complemento: Casa amarela cep: 69901-067 cidade: Rio Branco estado: AC telefone: (68) 3635-4277 celular: (68) 98181-4242 parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/editar' /api/instalacao/fechar/4ea936f0-a4c8-11ee-9bc4-080027c29949: get: summary: Fechar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_instalacao_fechar_yml description: >- #### Endpoint: api/instalacao/fechar ##### Método: GET **Descrição**: Este endpoint permite fechar uma instalação do sistema, passando o UUID na URL. tags: - Instalacao responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Registro fechado com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/instalacao/inserir: post: summary: Inserir operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_instalacao_inserir_yml description: >- #### Endpoint: api/instalacao/cadastro ##### Método: POST **Descrição**: Envia a instalação para conclusão no **WebAdmin**. | **Campo** _**/**_ `Observação` | _**Limite/Valor**_ | | --- | --- | | `nome`: Nome completo do cliente **\[campo obrigatório: sim\]** | 255 caracteres | | `Login`: Login do usuário. **\[campo obrigatório: sim\]** | 64 caracteres | | `senha`: Senha de acesso do cliente **\[campo obrigatório: sim\]** | 32 caracteres | | `email`: Endereço de e-mail para o envio de faturas, avisos, etc. | 255 caracteres | | `cpf`**:** CPF ou CNPJ com ou sem pontuação **\[campo obrigatório: sim\]** | 20 caracteres | | `rg`: Rg do cliente com ou sem pontuação | 255 caracteres | | `data_nasc`: Data de nascimento no formato dd/mm/aaaa. | 20 caracteres | | `endereco`: Endereço do cliente. | 255 caracteres | | `bairro`: Bairro do cliente. | 255 caracteres | | `numero`: Número do endereço. | 20 caracteres | | `complemento`: Informações adicionais para o endereço. | 255 caracteres | | `cep`: CEP do cliente. | 20 caracteres | | `cidade`: Cidade do cliente. | 255 caracteres | | `estado`: Estado do cliente. | 10 caracteres | | `telefone`: Número de telefone do cliente. | 255 caracteres | | `celular`: Número de celular do cliente. | 50 caracteres | tags: - Instalacao responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string dados: type: object properties: nome: type: string login: type: string senha: type: string email: type: string cpf: type: string rg: type: string data_nasc: type: string endereco: type: string bairro: type: string numero: type: string complemento: type: string cep: type: string cidade: type: string estado: type: string telefone: type: string celular: type: string example: status: sucesso mensagem: Registro inserido com sucesso dados: nome: Elisa Caroline Gonçalves login: elisa senha: '123' email: elisacarolinegoncalves@outloock.com.br cpf: 455.717.141-90 rg: 37.783.633-3 data_nasc: '1997-02-17' endereco: Rua Pêssego bairro: Morada do Sol numero: '404' complemento: Casa amarela cep: 69901-067 cidade: Rio Branco estado: AC telefone: (68) 3635-4277 celular: (68) 98181-4242 parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/inserir' /api/instalacao/listar/pagina=1: get: summary: Listar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_instalacao_listar_yml description: >- #### Endpoint: api/instalacao/listar ##### Método: GET **Descrição**: Retorna uma lista de instalações no formato JSON. **Paginação** A paginação é iniciada na página 1 por padrão. Para navegar entre os registros, o total de páginas é incluído no corpo da resposta, auxiliando na navegação. | Parâmetros de consulta | Descrição | Exemplo | | --- | --- | --- | | `pagina:` | Paginação para navegar entre os registros.(pagina padrão 1). | /listar/pagina=2 | | `limite:` | Quantidade de registros que serão retornados (limite maximo 500 padrão) _parâmetro opcional_ | /listar/pagina=9&limite=150 | **Filtro para consulta** Este endpoint aceita parâmetros para filtrar os resultados. Após api/instalacao/listar, adicione uma barra **`/`** e os parâmetros desejados. | Observação | Exemplo | | --- | --- | | Todos os parâmetros retornados na resposta **"instalacoes":** deste endpoint podem ser utilizados para filtrar os resultados da consulta, separando-os com **`&`**. | listar/login=lise | tags: - Instalacao responses: '200': description: '' content: application/json: schema: type: object properties: total_registros: type: number consulta_atual: type: number pagina_atual: type: number total_paginas: type: number instalacoes: type: array items: type: string properties: '0': type: object properties: id: type: string uuid: type: string login: type: string senha: type: string email: type: string nome: type: string cpf: type: string rg: type: string data_nasc: type: string endereco: type: string numero: type: string bairro: type: string cidade: type: string estado: type: string cep: type: string telefone: type: string celular: type: string obs: type: object tipo: type: string visita: type: string tecnico: type: string status: type: string visitado: type: string instalado: type: string datainst: type: string concluido: type: string '1': type: object properties: id: type: string uuid: type: string login: type: string senha: type: string email: type: string nome: type: string cpf: type: string rg: type: string data_nasc: type: string endereco: type: string numero: type: string bairro: type: string cidade: type: string estado: type: string cep: type: string telefone: type: string celular: type: string obs: type: string tipo: type: string visita: type: string tecnico: type: string status: type: string visitado: type: string instalado: type: string datainst: type: string concluido: type: string example: total_registros: 2 consulta_atual: 2 pagina_atual: 1 total_paginas: 1 instalacoes: - id: '95' uuid: 707128C7-B121-48FB-A6C4-AB69F7DA4C7A login: leti senha: '123' email: leticia_cristiane_damata@securitycontrol.com.br nome: Letícia Cristiane da Mata cpf: '93929332230' rg: 14.005.500-9 data_nasc: '2002-02-02' endereco: Avenida Paraná numero: '404' bairro: Centro cidade: Acrelândia estado: AC cep: 69945-970 telefone: (66)9999-9999 celular: (11)922224444 obs: null tipo: instalacao visita: '2023-10-18 15:38:15' tecnico: Jose Santos status: concluido visitado: sim instalado: sim datainst: '2023-10-17' concluido: xxx - id: '136' uuid: 4ea936f0-a4c8-11ee-9bc4-080027c29949 login: elisa senha: '123' email: elisacarolinegoncalves@outloock.com.br nome: Elisa Caroline Gonçalves cpf: 455.717.141-90 rg: 37.783.633-3 data_nasc: '1997-02-17' endereco: Rua Pêssego numero: '404' bairro: Morada do Sol cidade: Rio Branco estado: AC cep: 69901-067 telefone: (68) 3635-4277 celular: (68) 98181-4242 obs: API tipo: instalacao visita: '2023-12-29 00:00:00' tecnico: nenhum status: concluido visitado: sim instalado: sim datainst: '2023-12-29 15:37:17' concluido: xxx parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/instalacao/3532d4ff-a67f-11ee-9c16-080027c29949: delete: summary: Remover operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_instalacao_remover_yml description: >- #### Endpoint: api/instalacao/{uuid da instalção} ##### Método: DELETE **Descrição**: Deleta uma instalação específica passando o UUID no parâmetro da URL. tags: - Instalacao responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Registro excluido com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/instalacao/show/DB59F430-9E4D-4FFD-9A97-092CFDC8DDB3: get: summary: Show operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_instalacao_show_yml description: >- #### Endpoint: api/instalacao/Show/{uuid da instalação} ##### Método: GET **Descrição**: Retorna os detalhes de uma instalação específica no formato JSON, passando o UUID no parâmetro da URL. tags: - Instalacao responses: '200': description: '200' content: application/json: schema: type: object properties: id: type: string uuid_solic: type: string login: type: string senha: type: string email: type: string nome: type: string data_nasc: type: string cpf: type: string endereco: type: string bairro: type: string cidade: type: string estado: type: string cep: type: string telefone: type: string vencimento: type: string plano: type: string complemento: type: string rg: type: string celular: type: string comodato: type: string datainst: type: string visitado: type: string instalado: type: string tecnico: type: string obs: type: object tipo: type: string ip: type: string mac: type: object valor: type: object concluido: type: string promocod: type: string numero: type: string endereco_res: type: string numero_res: type: string bairro_res: type: string cidade_res: type: string cep_res: type: string estado_res: type: string complemento_res: type: string vendedor: type: string nextel: type: object disp: type: string contrato: type: string adesao: type: string visita: type: string equipamento: type: string codigo: type: string ipcadastro: type: object processamento: type: object opcelular: type: string status: type: string coordenadas: type: string login_atend: type: string ramal: type: string termo: type: string opcelular2: type: string celular2: type: object naturalidade: type: object dot_ref: type: object example: id: '95' uuid_solic: 707128C7-B121-48FB-A6C4-AB69F7DA4C7A login: leti senha: '123' email: leticia_cristiane_damata@securitycontrol.com.br nome: Letícia Cristiane da Mata data_nasc: '2002-02-02' cpf: '93929332230' endereco: Avenida Paraná bairro: Centro cidade: Acrelândia estado: AC cep: 69945-970 telefone: (66)9999-9999 vencimento: '15' plano: 20_MEGA_RURAL complemento: '296' rg: 14.005.500-9 celular: (11)922224444 comodato: sim datainst: '2023-10-17' visitado: sim instalado: sim tecnico: Jose Santos obs: null tipo: instalacao ip: 192.168.0.3 mac: null valor: null concluido: xxx promocod: nao numero: '404' endereco_res: Avenida Paraná numero_res: '404' bairro_res: Centro cidade_res: Acrelândia cep_res: 69945-970 estado_res: AC complemento_res: '296' vendedor: Marie Curie nextel: null disp: sim contrato: FE1A6C51 adesao: '800.00' visita: '2023-10-18 15:38:15' equipamento: Roteador 5g codigo: e5b6285526f99 ipcadastro: null processamento: null opcelular: nenhuma status: concluido coordenadas: '-9.1508586,-70.6209447' login_atend: admin ramal: todos termo: 95I/2023 opcelular2: nenhuma celular2: null naturalidade: null dot_ref: null parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/plano/editar: put: summary: Editar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_plano_editar_yml description: >- #### Endpoint: api/plano/editar ##### Método: PUT **Descrição**: Editar o plano no sistema. | _**Campo**_ | _**Limite/Valor**_ | | --- | --- | | `uuid` | 64 caracteres | | `nome` | 255 caracteres | | `titulo` | 255 caracteres | | `descricao` | LONGTEXT | | `tipo` | dedicado / semi-dedicado | | `valor` | 255 caracteres | | `velup` | 50 caracteres | | `veldown` | 50 caracteres | | `prioridade` | 1, 2, 3, 4, 5, 6, 7, 8 | | _**Observação**_ | | --- | | A velocidade de _**download/upload**_ deve ser enviada em **kbps** para garantir precisão na comunicação | | **nome**: nome do plano. | | **titulo**: Descrição do título e nome do plano a serem exibidos no boleto detalhado. | | **descricao**: Descrição do plano no hotsite. | | **tipo**: Defina o plano como dedicado ou semi-dedicado. | | **valor**: valor do plano | | **velup**: Taxa de upload | | **veldown**: Taxa de download | | **prioridade**: Defina as prioridades para o Mikrotik 1, 2, 3, 4, 5, 6, 7, 8. | tags: - Plano responses: '200': description: '500' content: application/json: schema: type: object properties: status: type: string mensagem: type: string dados: type: object properties: nome: type: string titulo: type: string descricao: type: string tipo: type: string valor: type: string velup: type: string veldown: type: string prioridade: type: string example: status: sucesso mensagem: Registro inserido com sucesso dados: nome: Rural de Alta Velocidade 75 Mbps titulo: Rural 75 MEGA RADIO descricao: >- Desfrute de uma experiência online sem interrupções com nosso Plano Rural de 75 Mbps. Navegue, transmita e conecte-se em alta velocidade, instalação rápida e sem limites de dados! Inserindo plano pela api tipo: dedicado valor: '77.00' velup: '75000' veldown: '75000' prioridade: '7' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/editar' /api/plano/inserir: post: summary: Inserir operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_plano_inserir_yml description: >- #### Endpoint: api/plano/inserir ##### Método: POST **Descrição**: Insere um novo plano. | _**Campo**_ | _**Limite/Valor**_ | | --- | --- | | `nome` | 255 caracteres | | `titulo` | 255 caracteres | | `descricao` | LONGTEXT | | `tipo` | dedicado / semi-dedicado | | `valor` | 255 caracteres | | `velup` | 50 caracteres | | `veldown` | 50 caracteres | | `prioridade` | 1, 2, 3, 4, 5, 6, 7, 8 | | _**Observação**_ | | --- | | A velocidade de _**download/upload**_ deve ser enviada em **kbps** para garantir precisão na comunicação | | **nome**: nome do plano. | | **titulo**: Descrição do título e nome do plano a serem exibidos no boleto detalhado. | | **descricao**: Descrição do plano no hotsite. | | **tipo**: Defina o plano como dedicado ou semi-dedicado. | | **valor**: valor do plano | | **velup**: Taxa de upload | | **veldown**: Taxa de download | | **prioridade**: Defina as prioridades para o Mikrotik 1, 2, 3, 4, 5, 6, 7, 8. | tags: - Plano responses: '200': description: '500' content: application/json: schema: type: object properties: status: type: string mensagem: type: string dados: type: object properties: nome: type: string titulo: type: string descricao: type: string tipo: type: string valor: type: string velup: type: string veldown: type: string prioridade: type: string example: status: sucesso mensagem: Registro inserido com sucesso dados: nome: Rural de Alta Velocidade 75 Mbps titulo: Rural 75 MEGA RADIO descricao: >- Desfrute de uma experiência online sem interrupções com nosso Plano Rural de 75 Mbps. Navegue, transmita e conecte-se em alta velocidade, instalação rápida e sem limites de dados! Inserindo plano pela api tipo: dedicado valor: '77.00' velup: '75000' veldown: '75000' prioridade: '7' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/inserir' /api/plano/listar/pagina=1: get: summary: Listar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_plano_listar_yml description: >- #### Endpoint: api/plano/listar ##### Método: GET **Descrição**: Retorna uma lista de planos no formato JSON. **Paginação** A paginação é iniciada na página 1 por padrão. Para navegar entre os registros, o total de páginas é incluído no corpo da resposta, auxiliando na navegação. | Parâmetros de consulta | Descrição | Exemplo | | --- | --- | --- | | `pagina:` | Paginação para navegar entre os registros.(pagina padrão 1). | /listar/pagina=2 | | `limite:` | Quantidade de registros que serão retornados (limite maximo 500 padrão) _parâmetro opcional_ | /listar/pagina=9&limite=150 | **Filtro para consulta** Este endpoint aceita parâmetros para filtrar os resultados. Após api/plano/listar, adicione uma barra **`/`** e os parâmetros desejados. | Observação | Exemplo | | --- | --- | | Todos os parâmetros retornados na resposta **"planos":** deste endpoint podem ser utilizados para filtrar os resultados da consulta, separando-os com **`&`**. | listar/nome=Prata | tags: - Plano responses: '200': description: '' content: application/json: schema: type: object properties: total_registros: type: number consulta_atual: type: number pagina_atual: type: number total_paginas: type: number planos: type: array items: type: string properties: '0': type: object properties: uuid: type: string nome: type: string valor: type: string velup: type: string veldown: type: string prioridade: type: string descricao: type: string '1': type: object properties: uuid: type: string nome: type: string valor: type: string velup: type: string veldown: type: string prioridade: type: string descricao: type: string '2': type: object properties: uuid: type: string nome: type: string valor: type: string velup: type: string veldown: type: string prioridade: type: string descricao: type: string example: total_registros: 3 consulta_atual: 3 pagina_atual: 1 total_paginas: 1 planos: - uuid: 5313EE5B-F8B4-4192-94EC-655EB5E8C4EF nome: PlanoEnd valor: '120.00' velup: '600000' veldown: '77000' prioridade: '7' descricao: "- Acesso em banda larga.\r\n- Conexão 24 horas na fibra.\r\n- Velocidade de acesso garantida no plano." - uuid: 71106EE5-6E2C-4171-B808-9422CC6285B4 nome: Prata valor: '110.00' velup: '77000' veldown: '77000' prioridade: '8' descricao: "- Acesso em banda larga.\r\n- Conexão 12 horas na fibra.\r\n- Velocidade de acesso garantida no plano. (maybe not :/) " - uuid: 00963f1a-afef-11ee-99e4-080027c29949 nome: RuraldeAltaVelocidade75Mbps valor: '77.00' velup: '75000' veldown: '75000' prioridade: '7' descricao: >- Desfrute de uma experiência online sem interrupções com nosso Plano Rural de 75 Mbps. Navegue, transmita e conecte-se em alta velocidade, instalação rápida e sem limites de dados! Inserindo plano pela api parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/plano/82f2ce58-a4e7-11ee-9d35-080027c29949: delete: summary: Remover operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_plano_remover_yml description: >- #### Endpoint: api/plano/{uuid do plano} ##### Método: DELETE **Descrição**: Deleta um plano específico passando o UUID no parâmetro da URL. tags: - Plano responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Registro excluido com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/plano/show/82f2ce58-a4e7-11ee-9d35-080027c29949: get: summary: Show operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_plano_show_yml description: >- #### Endpoint: api/plano/Show/{uuid do plano} ##### Método: GET **Descrição**: Retorna os detalhes de um plano específico em formato JSON. tags: - Plano responses: '200': description: '200' content: application/json: schema: type: object properties: nome: type: string uuid_plano: type: string valor: type: string velup: type: string veldown: type: string garup: type: string gardown: type: string tempoup: type: object tempodown: type: object prioridade: type: string maxup: type: string maxdown: type: string desaup: type: string desadown: type: string burst: type: object descricao: type: string oculto: type: string valor_scm: type: string valor_sva: type: string pool: type: object valor_desc: type: string list: type: object aliquota: type: string cfop_plano: type: string desc_titulo: type: string perc_ibpt: type: string tipo: type: string ipv6a: type: object ipv6b: type: object vpm: type: string faixa: type: string tecnologia: type: string pis_pasep: type: string cofins: type: string perc_ibpt_m: type: string perc_ibpt_e: type: string perc_ibpt_f: type: string example: nome: 20_MEGA_RURAL uuid_plano: C96F745E-1F0F-4430-9F01-341FD4DB9F51 valor: '70.00' velup: '60000' veldown: '30000' garup: '0' gardown: '0' tempoup: null tempodown: null prioridade: '8' maxup: '0' maxdown: '0' desaup: '0' desadown: '0' burst: null descricao: "- Acesso em banda larga.\r\n- Conexão 24 horas na fibra.\r\n- Velocidade de acesso garantida no plano.\r\nConnection" oculto: nao valor_scm: '0.00' valor_sva: '0.00' pool: null valor_desc: '0.00' list: null aliquota: '0.00' cfop_plano: '5307' desc_titulo: 20_MEGA_RURAL perc_ibpt: '0.00' tipo: semi-dedicado ipv6a: null ipv6b: null vpm: '2.33' faixa: '15' tecnologia: H pis_pasep: '0.00' cofins: '0.00' perc_ibpt_m: '0.00' perc_ibpt_e: '0.00' perc_ibpt_f: '0.00' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/plano/turbo: put: summary: Turbo operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_plano_turbo_yml description: >- #### Endpoint: api/plano/turbo ##### Método: POST **Descrição**: Altera um plano. A velocidade de _**download/upload**_ deve ser enviada em **kbps** para garantir precisão na comunicação | _**Campo / Observação**_ | _**Limite/Valor**_ | | --- | --- | | `garup`: Velocidade de upload garantida. | 50 caracteres | | `gardown`: Velocidade de download garantida. | 50 caracteres | | `maxup`: Limite máximo de upload. | 50 caracteres | | `maxdown`: Limite máximo de download. | 50 caracteres | | `desaup`: Ponto de queda de upload. | 50 caracteres | | `desadown`: Ponto de queda de download. | 50 caracteres | | `tempoup`: Tempo de upload | 50 caracteres | | `tempodown`: Tempo de download | 50 caracteres | | `uuid`: UUID necessário para enviar as configurações do modo turbo. | 64 caracteres | tags: - Plano responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string dados: type: object properties: garup: type: string gardown: type: string maxup: type: string maxdown: type: string desaup: type: string desadown: type: string tempoup: type: string tempodown: type: string uuid: type: string example: status: sucesso mensagem: Registro editado com sucesso dados: garup: '140000' gardown: '140000' maxup: '150000' maxdown: '150000' desaup: '100000' desadown: '100000' tempoup: '6' tempodown: '7' uuid: 71106EE5-6E2C-4171-B808-9422CC6285B4 parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/turbo' /api/titulo/aberto/31297759001: get: summary: Aberto operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_titulo_aberto_yml description: >- #### Endpoint: api/titulo/aberto/{cpf} #### Endpoint: api/titulo/aberto/{login} #### Método: GET **Descrição**: Retorna todos os títulos em **aberto** do cliente com base no **login** ou **CPF** (CPF sem caracteres especiais). tags: - Titulo responses: '200': description: '200' content: application/json: schema: type: object properties: Total: type: number titulos: type: array items: type: string properties: '0': type: object properties: uuid: type: string login: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string pix: type: string pix_link: type: string pix_qr: type: string '1': type: object properties: uuid: type: string login: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string '2': type: object properties: uuid: type: string login: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string '3': type: object properties: uuid: type: string login: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string '4': type: object properties: uuid: type: string login: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string '5': type: object properties: uuid: type: string login: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string example: Total: 6 titulos: - uuid: A25BD2A4-C98C-4DA6-B5B8-E745E42C2B01 login: lise status: aberto tipo: mensalidade valor: '110.00' linhadig: 34191.77005 00064.327778 70144.370007 1 95860000011000 datavenc: '2024-01-05 00:00:00' cpf_cnpj: '31297759001' pix: >- Seja bem vindo a documentação da API https://postman.mk-auth.com.br pix_link: >- https://provedor.app.br/pix/?C07NSlRISs1VKMvMS8lXSFRIyU8uzU3NK0k8vPzw4nyFlEQFxwBPBYWMkpKCYit9_YL84pLcxDy93GzdxNKSDL3k_Fy9pCIA pix_qr: >- data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJYAAACWCAIAAACzY+a1AAAEiklEQVR4nO2dQY7jMAwEN4v5/5dnb0EAaTgtsuNsw1XH2JKcNEhZFMU8vr+//0Ayfz/9ADAFCeNBwniQMB4kjAcJ40HCeJAwHiSMBwnjQcJ4kDCeL/G+x+MxH+w1pP7scBtnr6+e3qa3Xb/mpOcJ+rhYYTxIGI/qSJ+8z7G83vYcZdvW4l3rIcSet88sPmc9hA5WGA8SxoOE8RzPha/UjluciuqeG/PZZB5d2247acxYk9+qBiuMBwnjGTnSCbWrXD/UXeUkwnK6bPgfwArjQcJ4PuZIV0+lv8GeusraCddx9l8/FJ/hfWCF8SBhPEgYz2gu9Hr/SYTFssu6HaJ+AH3c982UWGE8SBjPsSN1uaw6DrKi593UywYx/iJm1tTY3fsWrDAeJIzn8amYwqkj1bF8o0l648VghfEgYTxIGM9xQr6+YyAuEiaJ8Y3dhtMlRz3cZA/EdRAAK4wHCeNRHalo1428v3q4bTLgaYeTCMtP/axM8m5IQrw1SBjP6Iio6Fjqto0w9/phY1evkU7uDdm40huxwniQMB4kjMeTR2pPsBRPGInJ/Nv57LQiw689i2xn6MksixXGg4TxqFu+E1fZaHsa5q7v1NMbRRrPPMkVqsEK40HCeEZhbtEX1W0tb4bbO+2H/etnnrjoSVusMB4kjAcJ47kiOrPl9N26jmU0ov6TBUnd4SRmRHTmjiBhPMfRmcmrv351vc0eSW/4rtMkxC2WFdErWGE8SBjP6IioJUTuOsy+dmh5NW3ka4vvya6ETawwHiSMBwnjOT7lq3vwyTneSQro+gB629Opt3HeqoZFxR1Bwng8CfkXLxtOadSs2XL6Nak7AxJIGM8V/9nU2PObJCGKWIIj9kqI5M7cESSMBwnj8STkP3lfuun2zvdd3XL6RVx7ETVYYTxIGI+nvHrjIKfXKenLlfrxTmM3jcoy9kIMWGE8SBiPpypwo+agd4i6yTUVCYtOtrheTbHCeJAwHiSMZ5SQb1kY1E1EXBk9k6T6Sf4qNdhuDRLGc+mior6qRytOvZyeVD9JQhTrzjR6rsEK40HCeMz/2XTNmfd6iAuCQRYnvO25AVYYDxLGg4TxeE42PdHnBku5BMtsd025BLZ84UeQMJ7Rn9+tVxsFAhqIm8mN0mDrVZ3JdjGLiluDhPGMojOW80f2El2TXczTEHkDcVwdrDAeJIwHCePxJOQ3brMsMCbJpdu23nlU73myIMEK40HCeEZ1Z05pJMZbfPWk5KTeoXibfbsYK4wHCeO5ou6M6CX0V8TnM4jvunXPjZNNrkCSpS1WGA8SxoOE8YyiM5MpYRL1F3NY6udsFLNcb6vrxtVtXWCF8SBhPJ4/v2twug+8ffUXVwuucgmnzr/uWT9vVYMVxoOE8XzMka5M9ttcIeO1Q3vhYXtkByuMBwnjQcJ4rsidEdtuX7ItZ4jqcfWrp7e5DiDUYIXxIGE85vLqNY3KMpOr23FrxIrClnFdqwusMB4kjMdcdwauByuMBwnjQcJ4kDAeJIwHCeNBwniQMB4kjAcJ40HCeJAwHiSM5x9rEb5LK9i2fwAAAABJRU5ErkJggg== - uuid: 4C284B78-1767-4054-B3F2-7A1E5126BF08 login: lise status: aberto tipo: mensalidade valor: '110.00' linhadig: 34191.77005 00064.407778 70144.370007 2 96170000011000 datavenc: '2024-02-05 00:00:00' cpf_cnpj: '31297759001' - uuid: 9FBA26CA-379D-497E-B9E3-F7967EF9782B login: lise status: aberto tipo: mensalidade valor: '110.00' linhadig: 34191.77005 00064.577778 70144.370007 9 96460000011000 datavenc: '2024-03-05 00:00:00' cpf_cnpj: '31297759001' - uuid: C5169BD5-E956-4B6B-B3FB-CEC1C91A1FAB login: lise status: aberto tipo: mensalidade valor: '110.00' linhadig: 34191.77005 00064.657778 70144.370007 3 96770000011000 datavenc: '2024-04-05 00:00:00' cpf_cnpj: '31297759001' - uuid: 016BD6AF-4219-4789-B53A-4DAE378112C9 login: lise status: aberto tipo: mensalidade valor: '110.00' linhadig: 34191.77005 00064.737778 70144.370007 6 97080000011000 datavenc: '2024-05-06 00:00:00' cpf_cnpj: '31297759001' - uuid: 39CD5CD7-5BB0-4288-B98B-94AA75032F9D login: lise status: aberto tipo: mensalidade valor: '110.00' linhadig: 34191.77005 00065.077778 70144.370007 7 97380000011000 datavenc: '2024-06-05 00:00:00' cpf_cnpj: '31297759001' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/titulo/listar/pagina=1: get: summary: Listar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_titulo_listar_yml description: >- #### Endpoint: api/titulo/listar ##### Método: GET **Descrição**: Retorna uma lista de títulos no formato JSON. **Paginação** A paginação é iniciada na página 1 por padrão. Para navegar entre os registros, o total de páginas é incluído no corpo da resposta, auxiliando na navegação. | Parâmetros de consulta | Descrição | Exemplo | | --- | --- | --- | | `pagina:` | Paginação para navegar entre os registros.(pagina padrão 1). | /listar/pagina=2 | | `limite:` | Quantidade de registros que serão retornados (limite maximo 500 padrão) _parâmetro opcional_ | /listar/pagina=9&limite=150 | **Filtro para consulta** Este endpoint aceita parâmetros para filtrar os resultados. Após api/titulo/listar, adicione uma barra **`/`** e os parâmetros desejados. | Observação | Exemplo | | --- | --- | | Todos os parâmetros retornados na resposta **"titulos":** deste endpoint podem ser utilizados para filtrar os resultados da consulta, separando-os com **`&`**. | listar/login=ada&tipo=mensalidade | tags: - Titulo responses: '200': description: '200' content: application/json: schema: type: object properties: total_registros: type: number limite_consulta: type: number pagina_atual: type: number total_paginas: type: number titulos: type: array items: type: string properties: '0': type: object properties: uuid: type: string titulo: type: string valor: type: string valorpag: type: string datavenc: type: string nossonum: type: object linhadig: type: object nome: type: string login: type: string cpf_cnpj: type: string tipo: type: string email: type: string endereco: type: string numero: type: string bairro: type: string complemento: type: string cidade: type: string estado: type: string cep: type: string status: type: string uuid_lanc: type: string pix: type: string pix_link: type: string pix_qr: type: string '1': type: object properties: uuid: type: string titulo: type: string valor: type: string valorpag: type: object datavenc: type: string nossonum: type: string linhadig: type: string nome: type: string login: type: string cpf_cnpj: type: string tipo: type: string email: type: string endereco: type: string numero: type: string bairro: type: string complemento: type: string cidade: type: string estado: type: string cep: type: string status: type: string uuid_lanc: type: string '2': type: object properties: uuid: type: string titulo: type: string valor: type: string valorpag: type: object datavenc: type: string nossonum: type: object linhadig: type: object nome: type: string login: type: string cpf_cnpj: type: string tipo: type: string email: type: string endereco: type: string numero: type: string bairro: type: string complemento: type: string cidade: type: string estado: type: string cep: type: string status: type: string uuid_lanc: type: string pix: type: string pix_link: type: string pix_qr: type: string '3': type: object properties: uuid: type: string titulo: type: string valor: type: string valorpag: type: string datavenc: type: string nossonum: type: object linhadig: type: object nome: type: string login: type: string cpf_cnpj: type: string tipo: type: string email: type: string endereco: type: string numero: type: string bairro: type: string complemento: type: string cidade: type: string estado: type: string cep: type: string status: type: string uuid_lanc: type: string '4': type: object properties: uuid: type: string titulo: type: string valor: type: string valorpag: type: object datavenc: type: string nossonum: type: object linhadig: type: object nome: type: string login: type: string cpf_cnpj: type: string tipo: type: string email: type: string endereco: type: string numero: type: string bairro: type: string complemento: type: string cidade: type: string estado: type: string cep: type: string status: type: string uuid_lanc: type: string pix: type: string pix_link: type: string pix_qr: type: string '5': type: object properties: uuid: type: string titulo: type: string valor: type: string valorpag: type: object datavenc: type: string nossonum: type: object linhadig: type: object nome: type: string login: type: string cpf_cnpj: type: string tipo: type: string email: type: string endereco: type: string numero: type: string bairro: type: string complemento: type: string cidade: type: string estado: type: string cep: type: string status: type: string uuid_lanc: type: string example: total_registros: 6 limite_consulta: 200 pagina_atual: 1 total_paginas: 1 titulos: - uuid: 3BCF358D-530E-4812-92D1-1568081F111F titulo: '726' valor: '120.00' valorpag: '120.00' datavenc: '2017-01-02 00:00:00' nossonum: null linhadig: null nome: Jose de Sousa Santos login: jose cpf_cnpj: '47226118661' tipo: mensalidade email: testeemail@gmail.com endereco: Quadra 2 Conjunto 2 numero: '344' bairro: Setor Leste (Vila Estrutural) complemento: Casa Amarela cidade: Brasília estado: DF cep: 71261-110 status: pago uuid_lanc: 3BCF358D-530E-4812-92D1-1568081F111F pix: >- Seja bem vindo a documentação da API https://postman.mk-auth.com.br '' pix_link: >- https://provedor.app.br/pix/?C07NSlRISs1VKMvMS8lXSFRIyU8uzU3NK0k8vPzw4nyFlEQFxwBPBYWMkpKCYit9_YL84pLcxDy93GzdxNKSDL3k_Fy9pCIFdXUA pix_qr: >- data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJYAAACWCAIAAACzY+a1AAAEfklEQVR4nO2d227jMAxEm8X+/y9nXwoji8g0LxO1A5/zGMuy6gEpmaLYx/P5/AJn/vz0AGAKEtqDhPYgoT1IaA8S2oOE9iChPUhoDxLag4T2IKE9f5PtHo/H/GFxSD1+RP7eo+Xxo+q5yZYb3tUrWKE9SGhP1pEeNPYXY8fS8J+xh3y/mnezVVcZvw35u1qCFdqDhPYgoT3lufCVyWdA3P7oOTnr5IlnyuVg3u9d/vK5T6YYrNAeJLRn5Ei1xEv/pSNK+sC8m4o/G35nwiZWaA8S2vOLHGkjShJTDeLkb5mMSg5WaA8S2oOE9ozmwon3j2cdyWyXjL/EEZbJZvLycXKwQnuQ0J6yI5Ukhlz2nNyYlW/qBo/IP7f6rCFYoT1IaE/WkcoXVMkO41Vl/sd2s8a9m8M0WKE9SGgPEtrz2BD1P2gs7qvDu+wkHlW1w0ncRwVWaA8S2lP+qGjEI5Ix6EnufUwcu8mTTL+XTzoxWKE9SGiP5oho7DEaIeN4AMk0w0kMZTkqbWq5KgiOFdqDhPYgoT3Z6Mz65sEW6OTqezPVvROqW775/NUYrNAeJLSnHOaOUYWMq8ct8/5HknIveRtEZ+AbJLSnvCLNB7KT/Uzi19pZ4GvlKuWFwyZXl2CF9iChPUhozyg6s+juY3PDkkmWyudyQSfLBebCO4KE9ogd6cXDPnYOSLX0r37MNIp/qb4lDrBCe5DQnlE294YjkI3yghMXvTORUHWKHyu0BwntQUJ7NAn5jXhEMo9UvkFaPTa8/Hsbb+Nz6was0B4ktEechLi8etDIcGncG3RyiWQDvNEzuTO3Bgnt0eTOLNkQQP9cZLyBZDBEZ+4IEtqDhPaUT/lOPgxekewnTOq/yMMlyc3kSd7sEqzQHiS0Z0cxS0kg+/KWdrO8Z4udfzVf8rW3iXvHCu1BQntG5dWrmSbxj5NUwWThm7OW7yQ9m2rNyYr01iChPUhoz47/XygpiBA3a3w2JHtuXG0w+WbDCu1BQns05dXfm12SLODViJJsCGQvn5tpfwa5M7cGCe3ZcdY+efWsZdBeErtZttRW8jobgwSs0B4ktAcJ7dHkzki2bScfBvk5KZ4pJd8hk41o8kjvCBLas7WYZWP79LJldVQSB54M3KsKIsRghfYgoT2j8uqSeyeR4knwfTIA7SGms6ckwQrtQUJ7kNCercUs/3twru7MQSNjszGP7imomXku0ZkbgYT2aP4RbJL4LE+j9ONkeJPF/eTglTy1Byu0BwntKWdzqzKjJ75oEgSv1itsOEPJcdo8WKE9SGgPEtozOtk02WSoXp1EZyQFO+PhnbUMIHcGvkFCe3YcEV1SzWHJu52q22xEhRrnreKek4NZghXag4T2/JgjbVT1SnYiCZ1IdhOX90pqk72CFdqDhPYgoT2juVCSd9PopLpdnN9teA/oqM5bccoXTkFCe0bFLCdIKvs28lDka/qg53yaIUmItwYJ7fmxbG5QgRXag4T2IKE9SGgPEtqDhPYgoT1IaA8S2oOE9iChPUhoDxLa8w/vJbtLe2IOfgAAAABJRU5ErkJggg== - uuid: 34011716-97A6-48F6-AB58-F13845346D2E titulo: '710' valor: '120.00' valorpag: null datavenc: '2024-01-10 00:00:00' nossonum: '177000007109' linhadig: 34191.77005 00071.097778 70144.370007 7 95910000019777 nome: Ada Lovelace login: ada cpf_cnpj: '71978536000124' tipo: mensalidade email: testeemail@gmail.com endereco: Rua José Carlos Gurgel Nogueira numero: '404' bairro: Vicente Pinzon complemento: até 209/210 cidade: Fortaleza estado: CE cep: '686577777' status: vencido uuid_lanc: 34011716-97A6-48F6-AB58-F13845346D2E - uuid: 951CF34E-D9DC-4DE0-B79C-77B587E7FF4D titulo: '707' valor: '120.00' valorpag: null datavenc: '2024-01-07 00:00:00' nossonum: null linhadig: null nome: Jose de Sousa Santos login: jose cpf_cnpj: '47226118661' tipo: mensalidade email: testeemail@gmail.com endereco: Quadra 2 Conjunto 2 numero: '344' bairro: Setor Leste (Vila Estrutural) complemento: Casa Amarela cidade: Brasília estado: DF cep: 71261-110 status: vencido uuid_lanc: 951CF34E-D9DC-4DE0-B79C-77B587E7FF4D pix: >- Por que os programadores não gostam de sair de casa? Porque eles preferem a segurança do seu "localhost"! pix_link: >- https://provedor.app.br/pix/?FYzBEcIwEMRaWdIILaSFnXgxzNjZcIcr4kEhaYz4pdFDWh14D8GJI1yDncWhxH5-jer8sKMIyVdMbkzesTpmpKaZ6aFQB5GqI7ifP6L4soGleWN7Xpvl9gc pix_qr: >- data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJYAAACWCAIAAACzY+a1AAAFmElEQVR4nO2d244iMQxEh9X+/y+zD0is1CF2uexmVEqdR5QbGBvHl+bxfD5/jDJ/fvsApotFKI9FKI9FKI9FKI9FKI9FKI9FKI9FKI9FKM/fdMTj8aBXf0Xv3iu8g3npmsHIXURw3SUlWBzfNz1J/wOMsRbKYxHKkxvSN7SBQuwnbmMJg7mbO2I28YN1LHyAtVCegha+QDQpHZB+YQl9XZcKdqHnzurrCrGatVAei1CesiElKP04p1dJwsThU/ALa0DH4SKwFspjEcrzDUP6JrCKu5HBKymBndzdC9MT4vfXr2EtlMcilKdsSDteFn6lDSxbasqCE6bmMXjlNWXE25z1VK2F8liE8hQMad8HQ6wiYWR2mdVgTXxKmr/F38tNTqy1UB6LUJ7ckH4n0EdUxPRd0xHD3h/QxFoozyP9juDpWaJALd0FSdv2C8XWg+3yHqVsLX4k/F2vWAvlsQjlmcxU7CwqnqBYQawT7s7gtpdIquC2N5hy+cQQrIXyWITy5B7p/6Gsy4ekDu4ovU2nEEU9yOLEmmnmJMBaKI9FKM9AcxqelcV9s1Kgiy5vQdxdPNuAX+1HKoPeWAvlsQjlKXukSENX6viVWlh2A/DWlmDMjpGy7vQYxJtasRbKYxHKw1/tO2UvxEMQ0pEEJQt/GYA3LyKL2yM9Gr7XPvjBx7+5aW1upwefaKbFlT7Qm07hmjMVJ2IRynPL05/wsNlubsf4EGG86l4f1+ybXA5roTwWoTxljxRx/HZmsNNyFqy2m3hrKTCRQkEOtvuQA6yF8liE8hQCbNeZsLKXqvDSAYRlI0qzd5R+AlKrSFjaFWuhPBahPJNdvoONKUgAlqjQiTeNF78sglzYiYMRn6G1UB6LUJ6BBzunHhfh9I7cl9dM1s4YBm8hzRx13p1TvubnB7kXEle3lI6SjVzyiNK6dGQ6BV/EAbazsAjlKQfYRoL6t0a2Rkxc52DpSdKIowNsZ2ERylMOsCE6TpSTdKzxzr3Ej0H4kHj6Bbl0diy8tVAei1Ae3iNdoR2wj6/g4PUmeMvZbjUigBAcA2/hCLAWymMRylN+EuLs7Ri3vcHcfpCWKG+ZBT/PirVQHotQnsKDnfE0EB69TOOKeFULUSqOt0gGuwRzCXNN5H6thfIMPLRkJBmbfmH7edRgkZuukruQZCfZsmItlMcilIfvqfiwFmz9qtb749x+yy6xSwCeQlmn7E7ie+ERWITyTD6PdKTC9eLFERGv77jK+JQAomFjxVooj0Uozy3/2YQvNdKi0E8m4OchDky4uzakZ2ERylPOVARGAI/uz3bq9m/Q60jCOKcx0rRZjtvXWiiPRSjP5NUeJw0CdNZ8ExguolZl9zkQZeYprp05i4FSYCLcTvye31He0bnkEdXMRD+GtfAILEJ5yo9LKKUj8Lmd5Ea6O+5o/FapjmtnjsYilKcQYNu9jruIhLXspDLwfRH7maYs0jsuMsUBthOxCOWZ/FP0TqfZZZGO/ezkAQjvGj8Pt2+KtVAei1CeQqYCL8fDPcB1ChHwTI+xo5O+viks4BjpiViE8ky2xWz3AGwO7s12aiE7sQWiAxI/qmOkR3PLX1C+wcspdjkEokU2GJnujvOdeyqCtVAei1Cegf+pWLkjUxG0wO24o7QOSWUQvokDbEdjEcpTMKQvSq0LlymdKjx8CuLmXbodCJC5hKl3gO1ELEJ5yoaUoOSREt0Ou112a66LB+ABtvQkQZcaeOCPWAvlsQjl+YYhXRlpbQkG4/viuxBObJolvoyMx+ywFspjEcoz8NwZYkqnaHo3EjlPulTqzd4UI+1gLZSn/M9pBGmre7BLp4qCaIELrm54NV4f99qfhUUozzcq2MytWAvlsQjlsQjlsQjlsQjlsQjlsQjlsQjlsQjlsQjlsQjl+Qd9G4Bhc7cetQAAAABJRU5ErkJggg== - uuid: 376DE94A-8241-445D-A785-EC1B081C1F13 titulo: '717' valor: '0.00' valorpag: '0.00' datavenc: '2024-01-15 00:00:00' nossonum: null linhadig: null nome: Letícia Cristiane da Mata login: leti cpf_cnpj: '93929332230' tipo: mensalidade email: leticia_cristiane_damata@securitycontrol.com.br endereco: Avenida Paraná numero: '404' bairro: Centro complemento: '296' cidade: Acrelândia estado: AC cep: 69945-970 status: pago uuid_lanc: 376DE94A-8241-445D-A785-EC1B081C1F13 - uuid: 1D8AA240-A65F-455F-B05F-751A4987EB28 titulo: '727' valor: '120.00' valorpag: null datavenc: '2024-07-05 00:00:00' nossonum: null linhadig: null nome: Jose de Sousa Santos login: jose cpf_cnpj: '47226118661' tipo: mensalidade email: testeemail@gmail.com endereco: Quadra 2 Conjunto 2 numero: '344' bairro: Setor Leste (Vila Estrutural) complemento: Casa Amarela cidade: Brasília estado: DF cep: 71261-110 status: aberto uuid_lanc: 1D8AA240-A65F-455F-B05F-751A4987EB28 pix: >- No meio desse exemplo, as chaves PIX tão mais escondidas que o easter egg no código fonte! Mas não se preocupa, é só seguir a lógica, só falta o _If else_ do dinheiro aparecer sem condições! pix_link: >- https://provedor.app.br/pix/?HY47DsIwEESvMulzEQoQJR1a2RPHUuIN3gRxHwpEHXECX4yFdt78ToqZWRFpRvDBeZm0hxjCKHcazocL1vZ0m2QDLWiJOTq_bYSCYisrmBKKIrQ95qQYtKzscHRb-WW9eqnUsC3So71hbXctbblCMLU95eDgpw4yreK918MATsYrop_LZWSuClmkMvieccb_SXu1D637Ag pix_qr: >- data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJYAAACWCAIAAACzY+a1AAAHlElEQVR4nO2dy47rOAwF04P5/1/uWeQiMGTmsEg5c8H41DLWg26JEl9J//z+/j7MZP752wKYXbyE4/ESjsdLOB4v4Xi8hOPxEo7HSzief8Wzn5+f0lhLlODZXYQOwvGf7V+Pjt2JPMfur75iolSkZZDwHfUrnKfb/MMuWAvHo7TwCYnAiW11fBSqxfLhMhTcsFrhjm3CBtXz4Dxvabq0rxZswVo4nlwLnzSuk/PpTzRAXCTLyFyk40T6MhM3ljg5UoXTVF9kwVo4Hi/heOhBei1VCzs8A8UgwvTQLcPT8p08y5jQS7kca+F4PqiF5x39+iR1Qqo7Wnsm4cipIxG2r4Yv/gesheOhWtjeaDzalN5txH8X0lZDB8K1138NeKGW2gishePxEo4nP0jbZvHZ4A4PMW0vCKs9jYnoMzAUDI7ZGOT8Clf5G9bC8SgtvMRWFlsyhGzzdPzjIy4kGZOTJjGuwlo4nh8Y2ucZ86V72CDVJ2K1bwa0euUESwNRJFAdn4u3YC0cj5dwPOog/dMCp2SX9vBg1KdWz/TnZyyPeaYZYzJpevBW/3oPa+EXkJszT3hUkFP1B8QO1QLwkyYdmSjojvNDpluwFo7nGi0U3TfvLahAjTRe9e24bkFP4yrXwlo4nnLWvppgE5u9GnV7N9G5ZTvqJqQNFSicDs5LJLFFegu8hOMpx0irocKUS8op9BHNz9U0rpu2fwCbhf9JCdbC8eQBtrhb0UkQg/CkRNUKJzu6GpRoux/H7jzTYqfiFtC7UDR4YC0hGbWqJ8CvqKoM1TH1BVwNCoYyh1gLx+MlHM+WU8FbCn+Dn1fvukDx0kHCltUs4Lsux47cJrI5cwvyIkSiQOlmqV7gWgYhSTXHGbbhNs550sYjEQpwjPQWlF17ntFOW/Zy/eeJUnZy5ZvXXnW6pY3vwlvgJRwP/Q02bblcYkan4c3qVc8TKTxbwrMx4WXBU8Qca+F4tn79aXlK0mBndOUSV2Ix0fFDEtetVkaJlqL7VQ6+tXA81LUPH2nOOyjUrUae+qxV4VVN7kKhOscCpBK9dET1vHlhLRyPl3A8NDpDjJRqfQOJeYrux5Z6fFKDdP6wXRgB3ZW2ybZgLRzP1m+wtZNzoZUvBoEOwLtH3C7jEeB0OkE1B2mn4stpfss3fJSivXgODK21q61C0vgfYfPaC7EWjueaHy1Jc+tV645kIkWDpRk3PlNpuRVNXgTK7Lvwy/ESjod+UfvFZs3EeRAdOD22F0LyhJ8+k8+CkZMtPWMbcJPHWjie8ncq+AVeNZS4fp9bbvoP1e6NlMuOY2Nz5stp5gsX0htCZPWW9qEMSwPoIGu16FXlXKJhYfv2VWotHI+XcDx5EWI76JBa4Uvfqnki5EmlWjqGMpCSjlAGUWsiBOPJmQVr4Xiu/7mEBe4RV1XzPP4+qWvPuSTmQCa1Fo6n+S3fXgBMH/e9hByJ0l2eWeRXtX6746NqTuOFtXA8XsLxbMVIF9Ljq5rIDcfnQpLxPyfzZvCIYy0cT/M/p20a3MLT4IZPNZIpHglrqJFbgF3aJtiCtXA8uRaSHS12ZeqbL0+rQYN0QC7eI9I/HTYjY74TTPtpaUDuhbVwPF7C8ZRTviKGkh4gPMAfTkc8Bx7pgCd8O3TZCwnZnLkjzUzFOkorq1cNnIrpqmr3bvZ0ED3meWQefW0vhLVwPDRrr93qnv61EQqUeuViwBfP7tWiBVKdld7fjavXWjgeGmDTbjIskFn26fERGVlckPrK4aby2QAmUT3+N+FSOWt/I7yE47nmJ2V74U1yKFUN9LCBKP44zqJJCy9IbQofhAtmLRwP/T3S8FF1m4fmTDgmMdBTLsnqhe3DrAI5JI5v186uLFgLx1P+JwdHeC6tfQMJREaNOxXC1w77Vl+E1zzYtb8vXsLxNAsvSJXA8RAgR02aLxTo822znEnAz8C0/EmMr7EWjqf58+riQhZaRUIBVXdlmau3o8Pu1ZOmkQ09C9Y4D6yF49n6R7BhS2J2p5mKal2JNtC5eMJRCeEvovu+a2mn4hZ4Ccfzwe9UwPIkbihVE606eHR59JW/yFmqHayF49n6d8yfi3zyhBwXjyQ1xcjhIL1AAc+22rW/BeXfIz2i94gIKfWmC8cRcSwe8SIGfdXpvvB4sFPx5XgJx3PldyqeiJOK39jVaEvjuIOWSDU49e5DKFjD57EWjmfrfza96MXaedAybJma/gskMZJaFvwg4R+mwRObM19OswgxJEzQi4I7MQgvOiIa07vvuX7r2d89IkP5LrwFWz9a8kIku6sBOWF8Lm16uTqdoE+DBlU7czOJmLZ/WAu/AC/heJrlT082SxPImQlta2L+hMLzEo3wRuCmfyoYyYaGWAvHc41rH1KNzYttnkb9tX2xmZAT7LgHOvXPBbMWjueDWnjcocRN5nUl5/3LNy+5Y3gBTm+KMAbSxlo4Hi/heOhByrWeH4/c9BBxFl6fuAwFCy/4mNVCKVL+RLAWjmer/GmBuwqwvRZMOCHhdEJafjyQBryG8TzyMoUzFbfgmtoZ8xexFo7HSzgeL+F4vITj8RKOx0s4Hi/heLyE4/ESjuc/3F8HsnB59PUAAAAASUVORK5CYII= - uuid: 8F5A6DFE-C961-4775-B50A-9A696B81C891 titulo: '728' valor: '120.00' valorpag: null datavenc: '2024-07-05 00:00:00' nossonum: null linhadig: null nome: Jose de Sousa Santos login: jose cpf_cnpj: '47226118661' tipo: mensalidade email: testeemail@gmail.com endereco: Quadra 2 Conjunto 2 numero: '344' bairro: Setor Leste (Vila Estrutural) complemento: Casa Amarela cidade: Brasília estado: DF cep: 71261-110 status: aberto uuid_lanc: 8F5A6DFE-C961-4775-B50A-9A696B81C891 parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/titulo/pago/JOSE: get: summary: Pago operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_titulo_pago_yml description: >- #### Endpoint: api/titulo/pago/{cpf} #### Endpoint: api/titulo/pago/{login} #### Método: GET **Descrição**: Retorna todos os títulos **pagos** do cliente com base no **login** ou **CPF** (CPF sem caracteres especiais). tags: - Titulo responses: '200': description: '200' content: application/json: schema: type: object properties: Total: type: number titulos: type: array items: type: string properties: '0': type: object properties: uuid: type: string login: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string pix: type: string pix_link: type: string pix_qr: type: string '1': type: object properties: uuid: type: string login: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string example: Total: 2 titulos: - uuid: 484D26BD-B190-404A-A857-BDEDC4C5E9B3 login: jose status: pago tipo: mensalidade valor: '110.00' linhadig: 34191.77005 00062.267778 70144.370007 9 95880000011000 datavenc: '2024-01-07 00:00:00' cpf_cnpj: '47226118661' pix: >- Seja bem vindo a documentação da API https://postman.mk-auth.com.br pix_link: >- https://provedor.app.br/pix/?C07NSlRISs1VKMvMS8lXSFRIyU8uzU3NK0k8vPzw4nyFlEQFxwBPBYWMkpKCYit9_YL84pLcxDy93GzdxNKSDL3k_Fy9pCIA pix_qr: >- data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJYAAACWCAIAAACzY+a1AAAEiklEQVR4nO2dQY7jMAwEN4v5/5dnb0EAaTgtsuNsw1XH2JKcNEhZFMU8vr+//0Ayfz/9ADAFCeNBwniQMB4kjAcJ40HCeJAwHiSMBwnjQcJ4kDCeL/G+x+MxH+w1pP7scBtnr6+e3qa3Xb/mpOcJ+rhYYTxIGI/qSJ+8z7G83vYcZdvW4l3rIcSet88sPmc9hA5WGA8SxoOE8RzPha/UjluciuqeG/PZZB5d2247acxYk9+qBiuMBwnjGTnSCbWrXD/UXeUkwnK6bPgfwArjQcJ4PuZIV0+lv8GeusraCddx9l8/FJ/hfWCF8SBhPEgYz2gu9Hr/SYTFssu6HaJ+AH3c982UWGE8SBjPsSN1uaw6DrKi593UywYx/iJm1tTY3fsWrDAeJIzn8amYwqkj1bF8o0l648VghfEgYTxIGM9xQr6+YyAuEiaJ8Y3dhtMlRz3cZA/EdRAAK4wHCeNRHalo1428v3q4bTLgaYeTCMtP/axM8m5IQrw1SBjP6Iio6Fjqto0w9/phY1evkU7uDdm40huxwniQMB4kjMeTR2pPsBRPGInJ/Nv57LQiw689i2xn6MksixXGg4TxqFu+E1fZaHsa5q7v1NMbRRrPPMkVqsEK40HCeEZhbtEX1W0tb4bbO+2H/etnnrjoSVusMB4kjAcJ47kiOrPl9N26jmU0ov6TBUnd4SRmRHTmjiBhPMfRmcmrv351vc0eSW/4rtMkxC2WFdErWGE8SBjP6IioJUTuOsy+dmh5NW3ka4vvya6ETawwHiSMBwnjOT7lq3vwyTneSQro+gB629Opt3HeqoZFxR1Bwng8CfkXLxtOadSs2XL6Nak7AxJIGM8V/9nU2PObJCGKWIIj9kqI5M7cESSMBwnj8STkP3lfuun2zvdd3XL6RVx7ETVYYTxIGI+nvHrjIKfXKenLlfrxTmM3jcoy9kIMWGE8SBiPpypwo+agd4i6yTUVCYtOtrheTbHCeJAwHiSMZ5SQb1kY1E1EXBk9k6T6Sf4qNdhuDRLGc+mior6qRytOvZyeVD9JQhTrzjR6rsEK40HCeMz/2XTNmfd6iAuCQRYnvO25AVYYDxLGg4TxeE42PdHnBku5BMtsd025BLZ84UeQMJ7Rn9+tVxsFAhqIm8mN0mDrVZ3JdjGLiluDhPGMojOW80f2El2TXczTEHkDcVwdrDAeJIwHCePxJOQ3brMsMCbJpdu23nlU73myIMEK40HCeEZ1Z05pJMZbfPWk5KTeoXibfbsYK4wHCeO5ou6M6CX0V8TnM4jvunXPjZNNrkCSpS1WGA8SxoOE8YyiM5MpYRL1F3NY6udsFLNcb6vrxtVtXWCF8SBhPJ4/v2twug+8ffUXVwuucgmnzr/uWT9vVYMVxoOE8XzMka5M9ttcIeO1Q3vhYXtkByuMBwnjQcJ4rsidEdtuX7ItZ4jqcfWrp7e5DiDUYIXxIGE85vLqNY3KMpOr23FrxIrClnFdqwusMB4kjMdcdwauByuMBwnjQcJ4kDAeJIwHCeNBwniQMB4kjAcJ40HCeJAwHiSM5x9rEb5LK9i2fwAAAABJRU5ErkJggg== - uuid: 1CC15C99-D8E6-4B47-BB87-2CAC3B4E13FD login: jose status: pago tipo: mensalidade valor: '110.00' linhadig: 34191.77005 00062.347778 70144.370007 1 96190000011000 datavenc: '2024-02-07 00:00:00' cpf_cnpj: '47226118661' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/titulo/receber: put: summary: Receber operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_titulo_receber_yml description: >- #### Endpoint: api/titulo/inserir ##### Método: PUT **Descrição**: Dá baixa em um título do sistema. | _**Campo**_ | _**Limite/Valor**_ | | --- | --- | | `coletor` | 20 caracteres | | `valor` | 50 caracteres | | `forma` | 100 caracteres | | `uuid` | 48 caracteres | | _**Observação**_ | | --- | | **coletor**: Responsável por coletar o título.
**\[Ex: Admin, API\].** | | **valor**: Valor do pagamento. | | **forma**: Forma de pagamento do título.
**\[Ex: dinheiro, cheque, cartão, vale, pix, outros\]**. | | **uuid**: Necessário para receber o título. | tags: - Titulo responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string dados: type: object properties: coletor: type: string valor: type: string forma: type: string uuid: type: string example: status: sucesso mensagem: Registro fechado com sucesso dados: coletor: API valor: '120.00' forma: pix uuid: A25BD2A4-C98C-4DA6-B5B8-E745E42C2B01 parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/receber' /api/titulo/A25BD2A4-C98C-4DA6-B5B8-E745E42C2B01: delete: summary: Remover operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_titulo_remover_yml description: >- #### Endpoint: api/titulo/{uuid do título} ##### Método: DELETE **Descrição**: Deleta um título específico passando o UUID no parâmetro da URL. tags: - Titulo responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Registro excluido com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/titulo/show/AE91D370-DFAB-41CF-81C9-CAEFD69F3AFA: get: summary: Show operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_titulo_show_yml description: >- #### Endpoint: api/titulo/show/{uuid do título} ##### Método: GET **Descrição**: Retorna os dados do título específico em formato JSON, passando o UUID no parâmetro da URL. tags: - Titulo responses: '200': description: '200' content: application/json: schema: type: object properties: id: type: string datavenc: type: string nossonum: type: string datapag: type: object nome: type: object recibo: type: object status: type: string login: type: string tipo: type: string cfop_lanc: type: string obs: type: string processamento: type: string aviso: type: string url: type: object usergerou: type: string valorger: type: string coletor: type: object linhadig: type: string valor: type: string valorpag: type: object gwt_numero: type: string imp: type: string referencia: type: string tipocob: type: string codigo_carne: type: object chave_gnet: type: object chave_gnet2: type: object chave_juno: type: object chave_galaxpay: type: object chave_iugu: type: object numconta: type: string gerourem: type: string remvalor: type: string remdata: type: string formapag: type: object fcartaobandeira: type: object fcartaonumero: type: object fchequenumero: type: object fchequebanco: type: object fchequeagcc: type: object percmulta: type: string valormulta: type: string percmora: type: string valormora: type: string percdesc: type: string valordesc: type: string deltitulo: type: string datadel: type: object num_recibos: type: string num_retornos: type: string alt_venc: type: string uuid_lanc: type: string tarifa_paga: type: string id_empresa: type: string oco01: type: string oco02: type: string oco06: type: string codigo_barras: type: object pix: type: string pix_link: type: string pix_qr: type: string example: id: '657' datavenc: '2024-07-15 00:00:00' nossonum: '177000006572' datapag: null nome: null recibo: null status: aberto login: leti tipo: mensalidade cfop_lanc: '5307' obs: Primeira mensalidade do plano 215Mbps_Fibra processamento: '2023-12-22 12:00:10' aviso: nao url: null usergerou: mk-bot valorger: completo coletor: null linhadig: 34191.77005 00065.727778 70144.370007 6 97780000011000 valor: '110.00' valorpag: null gwt_numero: '657' imp: nao referencia: JUN/2024 tipocob: fat codigo_carne: null chave_gnet: null chave_gnet2: null chave_juno: null chave_galaxpay: null chave_iugu: null numconta: '3' gerourem: '0' remvalor: '110.00' remdata: '2024-07-15 00:00:00' formapag: null fcartaobandeira: null fcartaonumero: null fchequenumero: null fchequebanco: null fchequeagcc: null percmulta: '0.00' valormulta: '0.00' percmora: '0.00' valormora: '0.00' percdesc: '0.00' valordesc: '0.00' deltitulo: '0' datadel: null num_recibos: '0' num_retornos: '0' alt_venc: '0' uuid_lanc: AE91D370-DFAB-41CF-81C9-CAEFD69F3AFA tarifa_paga: '0.00' id_empresa: '3307939721' oco01: '0' oco02: '0' oco06: '0' codigo_barras: null pix: >- Seja bem vindo a documentação da API https://postman.mk-auth.com.br pix_link: >- https://provedor.app.br/pix/?C07NSlRISs1VKMvMS8lXSFRIyU8uzU3NK0k8vPzw4nyFlEQFxwBPBYWMkpKCYit9_YL84pLcxDy93GzdxNKSDL3k_Fy9pCIA pix_qr: >- data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJYAAACWCAIAAACzY+a1AAAEiklEQVR4nO2dQY7jMAwEN4v5/5dnb0EAaTgtsuNsw1XH2JKcNEhZFMU8vr+//0Ayfz/9ADAFCeNBwniQMB4kjAcJ40HCeJAwHiSMBwnjQcJ4kDCeL/G+x+MxH+w1pP7scBtnr6+e3qa3Xb/mpOcJ+rhYYTxIGI/qSJ+8z7G83vYcZdvW4l3rIcSet88sPmc9hA5WGA8SxoOE8RzPha/UjluciuqeG/PZZB5d2247acxYk9+qBiuMBwnjGTnSCbWrXD/UXeUkwnK6bPgfwArjQcJ4PuZIV0+lv8GeusraCddx9l8/FJ/hfWCF8SBhPEgYz2gu9Hr/SYTFssu6HaJ+AH3c982UWGE8SBjPsSN1uaw6DrKi593UywYx/iJm1tTY3fsWrDAeJIzn8amYwqkj1bF8o0l648VghfEgYTxIGM9xQr6+YyAuEiaJ8Y3dhtMlRz3cZA/EdRAAK4wHCeNRHalo1428v3q4bTLgaYeTCMtP/axM8m5IQrw1SBjP6Iio6Fjqto0w9/phY1evkU7uDdm40huxwniQMB4kjMeTR2pPsBRPGInJ/Nv57LQiw689i2xn6MksixXGg4TxqFu+E1fZaHsa5q7v1NMbRRrPPMkVqsEK40HCeEZhbtEX1W0tb4bbO+2H/etnnrjoSVusMB4kjAcJ47kiOrPl9N26jmU0ov6TBUnd4SRmRHTmjiBhPMfRmcmrv351vc0eSW/4rtMkxC2WFdErWGE8SBjP6IioJUTuOsy+dmh5NW3ka4vvya6ETawwHiSMBwnjOT7lq3vwyTneSQro+gB629Opt3HeqoZFxR1Bwng8CfkXLxtOadSs2XL6Nak7AxJIGM8V/9nU2PObJCGKWIIj9kqI5M7cESSMBwnj8STkP3lfuun2zvdd3XL6RVx7ETVYYTxIGI+nvHrjIKfXKenLlfrxTmM3jcoy9kIMWGE8SBiPpypwo+agd4i6yTUVCYtOtrheTbHCeJAwHiSMZ5SQb1kY1E1EXBk9k6T6Sf4qNdhuDRLGc+mior6qRytOvZyeVD9JQhTrzjR6rsEK40HCeMz/2XTNmfd6iAuCQRYnvO25AVYYDxLGg4TxeE42PdHnBku5BMtsd025BLZ84UeQMJ7Rn9+tVxsFAhqIm8mN0mDrVZ3JdjGLiluDhPGMojOW80f2El2TXczTEHkDcVwdrDAeJIwHCePxJOQ3brMsMCbJpdu23nlU73myIMEK40HCeEZ1Z05pJMZbfPWk5KTeoXibfbsYK4wHCeO5ou6M6CX0V8TnM4jvunXPjZNNrkCSpS1WGA8SxoOE8YyiM5MpYRL1F3NY6udsFLNcb6vrxtVtXWCF8SBhPJ4/v2twug+8ffUXVwuucgmnzr/uWT9vVYMVxoOE8XzMka5M9ttcIeO1Q3vhYXtkByuMBwnjQcJ4rsidEdtuX7ItZ4jqcfWrp7e5DiDUYIXxIGE85vLqNY3KMpOr23FrxIrClnFdqwusMB4kjMdcdwauByuMBwnjQcJ4kDAeJIwHCeNBwniQMB4kjAcJ40HCeJAwHiSM5x9rEb5LK9i2fwAAAABJRU5ErkJggg== parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/titulo/titulos/31297759001: get: summary: Titulos operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_titulo_titulos_yml description: >- #### Endpoint: api/titulo/titulos/{cpf} #### Endpoint: api/titulo/titulos/{login} #### Método: GET **Descrição**: Retorna todos os títulos \[**abertos**, **vencidos** e **pagos**\] com base no **login** ou **CPF** (CPF sem caracteres especiais). tags: - Titulo responses: '200': description: '200' content: application/json: schema: type: object properties: Total: type: number titulos: type: array items: type: string properties: '0': type: object properties: uuid: type: string login: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string pix: type: string pix_link: type: string pix_qr: type: string '1': type: object properties: uuid: type: string login: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string '2': type: object properties: uuid: type: string login: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string '3': type: object properties: uuid: type: string login: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string '4': type: object properties: uuid: type: string login: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string '5': type: object properties: uuid: type: string login: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string '6': type: object properties: uuid: type: string login: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string '7': type: object properties: uuid: type: string login: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string '8': type: object properties: uuid: type: string login: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string example: Total: 9 titulos: - uuid: 3BAABB2D-3407-4EE0-AE31-532BBB1A1469 login: lise status: vencido tipo: mensalidade valor: '110.00' linhadig: 34191.77005 00064.247778 70144.370007 5 95550000011000 datavenc: '2023-12-05 00:00:00' cpf_cnpj: '31297759001' pix: >- Seja bem vindo a documentação da API https://postman.mk-auth.com.br pix_link: >- https://provedor.app.br/pix/?C07NSlRISs1VKMvMS8lXSFRIyU8uzU3NK0k8vPzw4nyFlEQFxwBPBYWMkpKCYit9_YL84pLcxDy93GzdxNKSDL3k_Fy9pCIA pix_qr: >- data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJYAAACWCAIAAACzY+a1AAAEiklEQVR4nO2dQY7jMAwEN4v5/5dnb0EAaTgtsuNsw1XH2JKcNEhZFMU8vr+//0Ayfz/9ADAFCeNBwniQMB4kjAcJ40HCeJAwHiSMBwnjQcJ4kDCeL/G+x+MxH+w1pP7scBtnr6+e3qa3Xb/mpOcJ+rhYYTxIGI/qSJ+8z7G83vYcZdvW4l3rIcSet88sPmc9hA5WGA8SxoOE8RzPha/UjluciuqeG/PZZB5d2247acxYk9+qBiuMBwnjGTnSCbWrXD/UXeUkwnK6bPgfwArjQcJ4PuZIV0+lv8GeusraCddx9l8/FJ/hfWCF8SBhPEgYz2gu9Hr/SYTFssu6HaJ+AH3c982UWGE8SBjPsSN1uaw6DrKi593UywYx/iJm1tTY3fsWrDAeJIzn8amYwqkj1bF8o0l648VghfEgYTxIGM9xQr6+YyAuEiaJ8Y3dhtMlRz3cZA/EdRAAK4wHCeNRHalo1428v3q4bTLgaYeTCMtP/axM8m5IQrw1SBjP6Iio6Fjqto0w9/phY1evkU7uDdm40huxwniQMB4kjMeTR2pPsBRPGInJ/Nv57LQiw689i2xn6MksixXGg4TxqFu+E1fZaHsa5q7v1NMbRRrPPMkVqsEK40HCeEZhbtEX1W0tb4bbO+2H/etnnrjoSVusMB4kjAcJ47kiOrPl9N26jmU0ov6TBUnd4SRmRHTmjiBhPMfRmcmrv351vc0eSW/4rtMkxC2WFdErWGE8SBjP6IioJUTuOsy+dmh5NW3ka4vvya6ETawwHiSMBwnjOT7lq3vwyTneSQro+gB629Opt3HeqoZFxR1Bwng8CfkXLxtOadSs2XL6Nak7AxJIGM8V/9nU2PObJCGKWIIj9kqI5M7cESSMBwnj8STkP3lfuun2zvdd3XL6RVx7ETVYYTxIGI+nvHrjIKfXKenLlfrxTmM3jcoy9kIMWGE8SBiPpypwo+agd4i6yTUVCYtOtrheTbHCeJAwHiSMZ5SQb1kY1E1EXBk9k6T6Sf4qNdhuDRLGc+mior6qRytOvZyeVD9JQhTrzjR6rsEK40HCeMz/2XTNmfd6iAuCQRYnvO25AVYYDxLGg4TxeE42PdHnBku5BMtsd025BLZ84UeQMJ7Rn9+tVxsFAhqIm8mN0mDrVZ3JdjGLiluDhPGMojOW80f2El2TXczTEHkDcVwdrDAeJIwHCePxJOQ3brMsMCbJpdu23nlU73myIMEK40HCeEZ1Z05pJMZbfPWk5KTeoXibfbsYK4wHCeO5ou6M6CX0V8TnM4jvunXPjZNNrkCSpS1WGA8SxoOE8YyiM5MpYRL1F3NY6udsFLNcb6vrxtVtXWCF8SBhPJ4/v2twug+8ffUXVwuucgmnzr/uWT9vVYMVxoOE8XzMka5M9ttcIeO1Q3vhYXtkByuMBwnjQcJ4rsidEdtuX7ItZ4jqcfWrp7e5DiDUYIXxIGE85vLqNY3KMpOr23FrxIrClnFdqwusMB4kjMdcdwauByuMBwnjQcJ4kDAeJIwHCeNBwniQMB4kjAcJ40HCeJAwHiSM5x9rEb5LK9i2fwAAAABJRU5ErkJggg== - uuid: A25BD2A4-C98C-4DA6-B5B8-E745E42C2B01 login: lise status: aberto tipo: mensalidade valor: '110.00' linhadig: 34191.77005 00064.327778 70144.370007 1 95860000011000 datavenc: '2024-01-05 00:00:00' cpf_cnpj: '31297759001' - uuid: 4C284B78-1767-4054-B3F2-7A1E5126BF08 login: lise status: aberto tipo: mensalidade valor: '110.00' linhadig: 34191.77005 00064.407778 70144.370007 2 96170000011000 datavenc: '2024-02-05 00:00:00' cpf_cnpj: '31297759001' - uuid: 9FBA26CA-379D-497E-B9E3-F7967EF9782B login: lise status: aberto tipo: mensalidade valor: '110.00' linhadig: 34191.77005 00064.577778 70144.370007 9 96460000011000 datavenc: '2024-03-05 00:00:00' cpf_cnpj: '31297759001' - uuid: C5169BD5-E956-4B6B-B3FB-CEC1C91A1FAB login: lise status: aberto tipo: mensalidade valor: '110.00' linhadig: 34191.77005 00064.657778 70144.370007 3 96770000011000 datavenc: '2024-04-05 00:00:00' cpf_cnpj: '31297759001' - uuid: 016BD6AF-4219-4789-B53A-4DAE378112C9 login: lise status: aberto tipo: mensalidade valor: '110.00' linhadig: 34191.77005 00064.737778 70144.370007 6 97080000011000 datavenc: '2024-05-06 00:00:00' cpf_cnpj: '31297759001' - uuid: FF846B12-86DE-4F6B-84D4-CC97182EBF42 login: lise status: vencido tipo: servicos valor: '80.00' linhadig: 34191.77005 00064.817778 70144.370007 4 95670000008000 datavenc: '2023-12-17 00:00:00' cpf_cnpj: '31297759001' - uuid: 8BA22FF1-EDFA-4261-8499-0165490F1B8E login: lise status: pago tipo: mensalidade valor: '110.00' linhadig: 34191.77005 00064.997778 70144.370007 4 95260000011000 datavenc: '2023-11-06 00:00:00' cpf_cnpj: '31297759001' - uuid: 39CD5CD7-5BB0-4288-B98B-94AA75032F9D login: lise status: aberto tipo: mensalidade valor: '110.00' linhadig: 34191.77005 00065.077778 70144.370007 7 97380000011000 datavenc: '2024-06-05 00:00:00' cpf_cnpj: '31297759001' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/titulo/titulos: post: summary: Titulos_1 operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_titulo_titulos_1_yml description: >- #### Endpoint: api/titulo/titulos ##### Método: POST **Descrição**: Esse endpoint retorna os títulos dos clientes de acordo com os parâmetros passados no corpo da requisição. | _**Observação**_ | | --- | | **login**: Passando um array com os **Logins** dos clientes, retorna os títulos dos clientes. | | **cpf_cnpj**: Passando um array com os **CPF/CNPJ** dos clientes, retorna os títulos dos clientes. | | **status**: Os dados aceitos são: **aberto**, **vencido** e **pago**. Passe apenas um valor e retornará os títulos com esse status. | | _**Observação 2**_ | | --- | | **login**: Não é obrigatório. Caso não queira passá-lo, envie um array vazio ou não inclua 'login' no corpo da requisição. | | **cpf_cnpj**: Não é obrigatório. Caso não queira passá-lo, envie um array vazio ou não inclua 'cpf_cnpj' no corpo da requisição. | | **status**: Caso não seja especificado no corpo da requisição, todos os status serão retornados." | tags: - Titulo responses: '200': description: '' content: application/json: schema: type: object properties: Total: type: number titulos: type: array items: type: string properties: '0': type: object properties: uuid: type: string login: type: string titulo: type: string status: type: string tipo: type: string valor: type: string linhadig: type: object datavenc: type: string cpf_cnpj: type: string '1': type: object properties: uuid: type: string login: type: string titulo: type: string status: type: string tipo: type: string valor: type: string linhadig: type: object datavenc: type: string cpf_cnpj: type: string '2': type: object properties: uuid: type: string login: type: string titulo: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string '3': type: object properties: uuid: type: string login: type: string titulo: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string '4': type: object properties: uuid: type: string login: type: string titulo: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string '5': type: object properties: uuid: type: string login: type: string titulo: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string '6': type: object properties: uuid: type: string login: type: string titulo: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string '7': type: object properties: uuid: type: string login: type: string titulo: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string '8': type: object properties: uuid: type: string login: type: string titulo: type: string status: type: string tipo: type: string valor: type: string linhadig: type: object datavenc: type: string cpf_cnpj: type: string pix: type: string pix_link: type: string pix_qr: type: string '9': type: object properties: uuid: type: string login: type: string titulo: type: string status: type: string tipo: type: string valor: type: string linhadig: type: object datavenc: type: string cpf_cnpj: type: string example: Total: 10 titulos: - uuid: 63E6A5B0-9ACE-4FBB-99BF-C3E982BFEC91 login: jose titulo: '708' status: aberto tipo: mensalidade valor: '120.00' linhadig: null datavenc: '2024-02-07 00:00:00' cpf_cnpj: '47226118661' - uuid: CDF6FA90-DC0E-4096-9227-95D29E0B17CA login: jose titulo: '709' status: aberto tipo: mensalidade valor: '120.00' linhadig: null datavenc: '2024-03-07 00:00:00' cpf_cnpj: '47226118661' - uuid: 6607BCDE-ED80-495D-B0CE-67B40B2FA63B login: ada titulo: '711' status: aberto tipo: mensalidade valor: '120.00' linhadig: 34191.77005 00071.177778 70144.370007 1 96240000019777 datavenc: '2024-02-12 00:00:00' cpf_cnpj: '71978536000124' - uuid: 50C4BF95-84F3-4ED5-8DA3-CA01941A8B52 login: ada titulo: '712' status: aberto tipo: mensalidade valor: '120.00' linhadig: 34191.77005 00071.257778 70144.370007 9 96520000019777 datavenc: '2024-03-11 00:00:00' cpf_cnpj: '71978536000124' - uuid: 9808D9D2-16A3-4CF1-B7C9-EF56E5D34CCD login: ada titulo: '713' status: aberto tipo: mensalidade valor: '120.00' linhadig: 34191.77005 00071.337778 70144.370007 8 96820000019777 datavenc: '2024-04-10 00:00:00' cpf_cnpj: '71978536000124' - uuid: 5498915D-2ECD-4CA4-BD53-9D5F229041DE login: mary titulo: '722' status: aberto tipo: mensalidade valor: '170.00' linhadig: 34191.77005 00072.247778 70144.370007 4 96190000017000 datavenc: '2024-02-07 00:00:00' cpf_cnpj: '11226522084' - uuid: 08F79FE1-2AD4-456E-AC2F-C8BEB4CA96EC login: mary titulo: '723' status: aberto tipo: mensalidade valor: '170.00' linhadig: 34191.77005 00072.327778 70144.370007 8 96480000017000 datavenc: '2024-03-07 00:00:00' cpf_cnpj: '11226522084' - uuid: D19DC691-861F-47D4-A914-85C7283C084D login: mary titulo: '724' status: aberto tipo: mensalidade valor: '170.00' linhadig: 34191.77005 00072.407778 70144.370007 2 96790000017000 datavenc: '2024-04-07 00:00:00' cpf_cnpj: '11226522084' - uuid: 1D8AA240-A65F-455F-B05F-751A4987EB28 login: jose titulo: '727' status: aberto tipo: mensalidade valor: '120.00' linhadig: null datavenc: '2024-07-05 00:00:00' cpf_cnpj: '47226118661' pix: >- No meio desse exemplo, as chaves PIX tão mais escondidas que o easter egg no código fonte! Mas não se preocupa, é só seguir a lógica, só falta o _If else_ do dinheiro aparecer sem condições! pix_link: >- https://provedor.app.br/pix/?HY47DsIwEESvMulzEQoQJR1a2RPHUuIN3gRxHwpEHXECX4yFdt78ToqZWRFpRvDBeZm0hxjCKHcazocL1vZ0m2QDLWiJOTq_bYSCYisrmBKKIrQ95qQYtKzscHRb-WW9eqnUsC3So71hbXctbblCMLU95eDgpw4yreK918MATsYrop_LZWSuClmkMvieccb_SXu1D637Ag pix_qr: >- data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJYAAACWCAIAAACzY+a1AAAHlElEQVR4nO2dy47rOAwF04P5/1/uWeQiMGTmsEg5c8H41DLWg26JEl9J//z+/j7MZP752wKYXbyE4/ESjsdLOB4v4Xi8hOPxEo7HSzief8Wzn5+f0lhLlODZXYQOwvGf7V+Pjt2JPMfur75iolSkZZDwHfUrnKfb/MMuWAvHo7TwCYnAiW11fBSqxfLhMhTcsFrhjm3CBtXz4Dxvabq0rxZswVo4nlwLnzSuk/PpTzRAXCTLyFyk40T6MhM3ljg5UoXTVF9kwVo4Hi/heOhBei1VCzs8A8UgwvTQLcPT8p08y5jQS7kca+F4PqiF5x39+iR1Qqo7Wnsm4cipIxG2r4Yv/gesheOhWtjeaDzalN5txH8X0lZDB8K1138NeKGW2gishePxEo4nP0jbZvHZ4A4PMW0vCKs9jYnoMzAUDI7ZGOT8Clf5G9bC8SgtvMRWFlsyhGzzdPzjIy4kGZOTJjGuwlo4nh8Y2ucZ86V72CDVJ2K1bwa0euUESwNRJFAdn4u3YC0cj5dwPOog/dMCp2SX9vBg1KdWz/TnZyyPeaYZYzJpevBW/3oPa+EXkJszT3hUkFP1B8QO1QLwkyYdmSjojvNDpluwFo7nGi0U3TfvLahAjTRe9e24bkFP4yrXwlo4nnLWvppgE5u9GnV7N9G5ZTvqJqQNFSicDs5LJLFFegu8hOMpx0irocKUS8op9BHNz9U0rpu2fwCbhf9JCdbC8eQBtrhb0UkQg/CkRNUKJzu6GpRoux/H7jzTYqfiFtC7UDR4YC0hGbWqJ8CvqKoM1TH1BVwNCoYyh1gLx+MlHM+WU8FbCn+Dn1fvukDx0kHCltUs4Lsux47cJrI5cwvyIkSiQOlmqV7gWgYhSTXHGbbhNs550sYjEQpwjPQWlF17ntFOW/Zy/eeJUnZy5ZvXXnW6pY3vwlvgJRwP/Q02bblcYkan4c3qVc8TKTxbwrMx4WXBU8Qca+F4tn79aXlK0mBndOUSV2Ix0fFDEtetVkaJlqL7VQ6+tXA81LUPH2nOOyjUrUae+qxV4VVN7kKhOscCpBK9dET1vHlhLRyPl3A8NDpDjJRqfQOJeYrux5Z6fFKDdP6wXRgB3ZW2ybZgLRzP1m+wtZNzoZUvBoEOwLtH3C7jEeB0OkE1B2mn4stpfss3fJSivXgODK21q61C0vgfYfPaC7EWjueaHy1Jc+tV645kIkWDpRk3PlNpuRVNXgTK7Lvwy/ESjod+UfvFZs3EeRAdOD22F0LyhJ8+k8+CkZMtPWMbcJPHWjie8ncq+AVeNZS4fp9bbvoP1e6NlMuOY2Nz5stp5gsX0htCZPWW9qEMSwPoIGu16FXlXKJhYfv2VWotHI+XcDx5EWI76JBa4Uvfqnki5EmlWjqGMpCSjlAGUWsiBOPJmQVr4Xiu/7mEBe4RV1XzPP4+qWvPuSTmQCa1Fo6n+S3fXgBMH/e9hByJ0l2eWeRXtX6746NqTuOFtXA8XsLxbMVIF9Ljq5rIDcfnQpLxPyfzZvCIYy0cT/M/p20a3MLT4IZPNZIpHglrqJFbgF3aJtiCtXA8uRaSHS12ZeqbL0+rQYN0QC7eI9I/HTYjY74TTPtpaUDuhbVwPF7C8ZRTviKGkh4gPMAfTkc8Bx7pgCd8O3TZCwnZnLkjzUzFOkorq1cNnIrpqmr3bvZ0ED3meWQefW0vhLVwPDRrr93qnv61EQqUeuViwBfP7tWiBVKdld7fjavXWjgeGmDTbjIskFn26fERGVlckPrK4aby2QAmUT3+N+FSOWt/I7yE47nmJ2V74U1yKFUN9LCBKP44zqJJCy9IbQofhAtmLRwP/T3S8FF1m4fmTDgmMdBTLsnqhe3DrAI5JI5v186uLFgLx1P+JwdHeC6tfQMJREaNOxXC1w77Vl+E1zzYtb8vXsLxNAsvSJXA8RAgR02aLxTo822znEnAz8C0/EmMr7EWjqf58+riQhZaRUIBVXdlmau3o8Pu1ZOmkQ09C9Y4D6yF49n6R7BhS2J2p5mKal2JNtC5eMJRCeEvovu+a2mn4hZ4Ccfzwe9UwPIkbihVE606eHR59JW/yFmqHayF49n6d8yfi3zyhBwXjyQ1xcjhIL1AAc+22rW/BeXfIz2i94gIKfWmC8cRcSwe8SIGfdXpvvB4sFPx5XgJx3PldyqeiJOK39jVaEvjuIOWSDU49e5DKFjD57EWjmfrfza96MXaedAybJma/gskMZJaFvwg4R+mwRObM19OswgxJEzQi4I7MQgvOiIa07vvuX7r2d89IkP5LrwFWz9a8kIku6sBOWF8Lm16uTqdoE+DBlU7czOJmLZ/WAu/AC/heJrlT082SxPImQlta2L+hMLzEo3wRuCmfyoYyYaGWAvHc41rH1KNzYttnkb9tX2xmZAT7LgHOvXPBbMWjueDWnjcocRN5nUl5/3LNy+5Y3gBTm+KMAbSxlo4Hi/heOhByrWeH4/c9BBxFl6fuAwFCy/4mNVCKVL+RLAWjmer/GmBuwqwvRZMOCHhdEJafjyQBryG8TzyMoUzFbfgmtoZ8xexFo7HSzgeL+F4vITj8RKOx0s4Hi/heLyE4/ESjuc/3F8HsnB59PUAAAAASUVORK5CYII= - uuid: 8F5A6DFE-C961-4775-B50A-9A696B81C891 login: jose titulo: '728' status: aberto tipo: mensalidade valor: '120.00' linhadig: null datavenc: '2024-07-05 00:00:00' cpf_cnpj: '47226118661' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: $ref: '#/components/requestBodies/titulos_1' /api/titulo/vencido/31297759001: get: summary: Vencido operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_titulo_vencido_yml description: >- #### Endpoint: api/titulo/vencido/{cpf} #### Endpoint: api/titulo/vencido/{login} #### Método: GET **Descrição**: Retorna todos os títulos **vencidos** do cliente com base no **login** ou **CPF** (CPF sem caracteres especiais). tags: - Titulo responses: '200': description: '200' content: application/json: schema: type: object properties: Total: type: number titulos: type: array items: type: string properties: '0': type: object properties: uuid: type: string login: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string pix: type: string pix_link: type: string pix_qr: type: string '1': type: object properties: uuid: type: string login: type: string status: type: string tipo: type: string valor: type: string linhadig: type: string datavenc: type: string cpf_cnpj: type: string example: Total: 2 titulos: - uuid: 3BAABB2D-3407-4EE0-AE31-532BBB1A1469 login: lise status: vencido tipo: mensalidade valor: '110.00' linhadig: 34191.77005 00064.247778 70144.370007 5 95550000011000 datavenc: '2023-12-05 00:00:00' cpf_cnpj: '31297759001' pix: >- Seja bem vindo a documentação da API https://postman.mk-auth.com.br pix_link: >- https://provedor.app.br/pix/?C07NSlRISs1VKMvMS8lXSFRIyU8uzU3NK0k8vPzw4nyFlEQFxwBPBYWMkpKCYit9_YL84pLcxDy93GzdxNKSDL3k_Fy9pCIA pix_qr: >- data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJYAAACWCAIAAACzY+a1AAAEiklEQVR4nO2dQY7jMAwEN4v5/5dnb0EAaTgtsuNsw1XH2JKcNEhZFMU8vr+//0Ayfz/9ADAFCeNBwniQMB4kjAcJ40HCeJAwHiSMBwnjQcJ4kDCeL/G+x+MxH+w1pP7scBtnr6+e3qa3Xb/mpOcJ+rhYYTxIGI/qSJ+8z7G83vYcZdvW4l3rIcSet88sPmc9hA5WGA8SxoOE8RzPha/UjluciuqeG/PZZB5d2247acxYk9+qBiuMBwnjGTnSCbWrXD/UXeUkwnK6bPgfwArjQcJ4PuZIV0+lv8GeusraCddx9l8/FJ/hfWCF8SBhPEgYz2gu9Hr/SYTFssu6HaJ+AH3c982UWGE8SBjPsSN1uaw6DrKi593UywYx/iJm1tTY3fsWrDAeJIzn8amYwqkj1bF8o0l648VghfEgYTxIGM9xQr6+YyAuEiaJ8Y3dhtMlRz3cZA/EdRAAK4wHCeNRHalo1428v3q4bTLgaYeTCMtP/axM8m5IQrw1SBjP6Iio6Fjqto0w9/phY1evkU7uDdm40huxwniQMB4kjMeTR2pPsBRPGInJ/Nv57LQiw689i2xn6MksixXGg4TxqFu+E1fZaHsa5q7v1NMbRRrPPMkVqsEK40HCeEZhbtEX1W0tb4bbO+2H/etnnrjoSVusMB4kjAcJ47kiOrPl9N26jmU0ov6TBUnd4SRmRHTmjiBhPMfRmcmrv351vc0eSW/4rtMkxC2WFdErWGE8SBjP6IioJUTuOsy+dmh5NW3ka4vvya6ETawwHiSMBwnjOT7lq3vwyTneSQro+gB629Opt3HeqoZFxR1Bwng8CfkXLxtOadSs2XL6Nak7AxJIGM8V/9nU2PObJCGKWIIj9kqI5M7cESSMBwnj8STkP3lfuun2zvdd3XL6RVx7ETVYYTxIGI+nvHrjIKfXKenLlfrxTmM3jcoy9kIMWGE8SBiPpypwo+agd4i6yTUVCYtOtrheTbHCeJAwHiSMZ5SQb1kY1E1EXBk9k6T6Sf4qNdhuDRLGc+mior6qRytOvZyeVD9JQhTrzjR6rsEK40HCeMz/2XTNmfd6iAuCQRYnvO25AVYYDxLGg4TxeE42PdHnBku5BMtsd025BLZ84UeQMJ7Rn9+tVxsFAhqIm8mN0mDrVZ3JdjGLiluDhPGMojOW80f2El2TXczTEHkDcVwdrDAeJIwHCePxJOQ3brMsMCbJpdu23nlU73myIMEK40HCeEZ1Z05pJMZbfPWk5KTeoXibfbsYK4wHCeO5ou6M6CX0V8TnM4jvunXPjZNNrkCSpS1WGA8SxoOE8YyiM5MpYRL1F3NY6udsFLNcb6vrxtVtXWCF8SBhPJ4/v2twug+8ffUXVwuucgmnzr/uWT9vVYMVxoOE8XzMka5M9ttcIeO1Q3vhYXtkByuMBwnjQcJ4rsidEdtuX7ItZ4jqcfWrp7e5DiDUYIXxIGE85vLqNY3KMpOr23FrxIrClnFdqwusMB4kjMdcdwauByuMBwnjQcJ4kDAeJIwHCeNBwniQMB4kjAcJ40HCeJAwHiSM5x9rEb5LK9i2fwAAAABJRU5ErkJggg== - uuid: FF846B12-86DE-4F6B-84D4-CC97182EBF42 login: lise status: vencido tipo: servicos valor: '80.00' linhadig: 34191.77005 00064.817778 70144.370007 4 95670000008000 datavenc: '2023-12-17 00:00:00' cpf_cnpj: '31297759001' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/usuario/editar: put: summary: Editar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_usuario_editar_yml description: >- #### Endpoint: api/usuario/editar ##### Método: PUT **Descrição**: Este endpoint permite a alteração de um novo usuário no sistema. A tabela de armazenamento é `sis_acesso`, que gerencia acessos de usuários administrativos ou operadores. O endpoint segue o padrão de API RESTful para MK-Auth API. - **Endpoint Base**: `/api/usuario/editar` - **Método**: PUT - **Autenticação**: Requer token JWT no header `Authorization: Bearer {TokenJWT}` (gerado via autenticação Basic Auth, conforme descrito na seção de Autenticação da coleção). - **Descrição**: Insere um novo registro de usuário na tabela `sis_acesso`. Campos obrigatórios incluem `login`, `sha` (hash SHA256 da senha), `email`, `nivel` e `nome`. Outros campos são opcionais e seguem os defaults da tabela. - **Observações**: - A senha deve ser enviada como hash SHA256 (campo `sha`). - Validações: O `login` deve ser único; campos enum como `horario` e `ativo` devem respeitar os valores permitidos ('sim' ou 'nao'). - Resposta de Sucesso: Retorna o UUID ou ID do novo usuário criado. ## Cabeçalhos (Headers) - `Authorization`: Bearer {TokenJWT} (obrigatório para autenticação). - `Content-Type`: application/json (para o corpo da requisição). ## Parâmetros do Corpo O corpo da requisição deve ser um objeto JSON com os campos baseados na tabela `sis_acesso`. Campos obrigatórios estão marcados com \*. | Campo | Tipo/Limite | Descrição | Obrigatório | Default/Exemplo | | --- | --- | --- | --- | --- | | uuid | varchar(64) | uuid do usuario no sistema. | Sim\* | | | login | varchar(255) | Nome de login do usuário (deve ser único). | Sim\* | "novo_usuario" | | sha | varchar(255) | Hash SHA256 da senha do usuário. | Sim\* | "hash_da_senha" (ex: SHA-256 da senha) | | email | varchar(255) | Endereço de e-mail do usuário. | Sim\* | "usuario@exemplo.com" | | nivel | varchar(255) | Nível de acesso (ex: hash ou código de permissão, conforme sistema). | Sim\* | "admin" ou hash como "21232f297a57a5a743894a0e4a801fc3" | | nome | varchar(255) | Nome completo do usuário. | Sim\* | "Nome Usuário" | | horario | enum('sim','nao') | Indica se o usuário tem restrição de horário. | Não | 'nao' | | tempoil | varchar(5) | Tempo inicial de login (formato HH:MM, se aplicável). | Não | "08:00" | | tempofl | varchar(5) | Tempo final de login (formato HH:MM, se aplicável). | Não | "18:00" | | ativo | enum('sim','nao') | Status de ativação do usuário. | Não | 'sim' | | key_onetime | varchar(16) | Chave one-time (para autenticação temporária). | Não | NULL | | cli_grupos | varchar(255) | Grupos de clientes associados (ex: 'full_clientes'). | Não | 'full_clientes' | ### Exemplo de Corpo JSON ``` json { "uuid": "uuid do usuario", "sha": "e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4", // Exemplo de hash SHA-1 para "senha123" "email": "novo@exemplo.com", "nivel": "admin", "nome": "Novo Usuário", "horario": "sim", "tempoil": "09:00", "tempofl": "17:00", "ativo": "sim" } ``` ## Respostas Esperadas ### Sucesso (200 OK) - **Descrição**: Usuário inserido com sucesso. - **Corpo JSON**: ``` json { "status": "sucesso", "mensagem": "Usuário inserido com sucesso", "dados": { "idacesso": 123, // ID gerado "uuid": "exemplo-uuid-gerado", // Opcional, se o sistema gerar UUID "login": "novo_usuario" } } ``` ## Exemplo de Requisição no Postman - **URL**: `https://{{IP_MK-AUTH}}/api/usuario/inserir` (substitua `{{IP_MK-AUTH}}` pela URL do seu sistema). - **Método**: POST - **Headers**: - Authorization: Bearer {{TokenJWT}} - **Body**: Raw JSON (como no exemplo acima). ## Observações Adicionais - **Segurança**: Certifique-se de usar HTTPS para proteger senhas e dados sensíveis. tags: - Usuario responses: '200': description: '' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: content: text/plain: schema: type: string /api/usuario/inserir: post: summary: Inserir operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_usuario_inserir_yml description: >- #### Endpoint: api/usuario/inserir ##### Método: POST **Descrição**: Este endpoint permite a inserção de um novo usuário no sistema. A tabela de armazenamento é `sis_acesso`, que gerencia acessos de usuários administrativos ou operadores. O endpoint segue o padrão de API RESTful para MK-Auth API. - **Endpoint Base**: `/api/usuario/inserir` - **Método**: POST - **Autenticação**: Requer token JWT no header `Authorization: Bearer {TokenJWT}` (gerado via autenticação Basic Auth, conforme descrito na seção de Autenticação da coleção). - **Descrição**: Insere um novo registro de usuário na tabela `sis_acesso`. Campos obrigatórios incluem `login`, `sha` (hash SHA256 da senha), `email`, `nivel` e `nome`. Outros campos são opcionais e seguem os defaults da tabela. - **Observações**: - A senha deve ser enviada como hash SHA256 (campo `sha`). - Validações: O `login` deve ser único; campos enum como `horario` e `ativo` devem respeitar os valores permitidos ('sim' ou 'nao'). - Resposta de Sucesso: Retorna o UUID ou ID do novo usuário criado. ## Cabeçalhos (Headers) - `Authorization`: Bearer {TokenJWT} (obrigatório para autenticação). - `Content-Type`: application/json (para o corpo da requisição). ## Parâmetros do Corpo O corpo da requisição deve ser um objeto JSON com os campos baseados na tabela `sis_acesso`. Campos obrigatórios estão marcados com \*. | Campo | Tipo/Limite | Descrição | Obrigatório | Default/Exemplo | | --- | --- | --- | --- | --- | | login | varchar(255) | Nome de login do usuário (deve ser único). | Sim\* | "novo_usuario" | | sha | varchar(255) | Hash SHA256 da senha do usuário. | Sim\* | "hash_da_senha" (ex: SHA-256 da senha) | | email | varchar(255) | Endereço de e-mail do usuário. | Sim\* | "usuario@exemplo.com" | | nivel | varchar(255) | Nível de acesso (ex: hash ou código de permissão, conforme sistema). | Sim\* | "admin" ou hash como "21232f297a57a5a743894a0e4a801fc3" | | nome | varchar(255) | Nome completo do usuário. | Sim\* | "Nome Usuário" | | horario | enum('sim','nao') | Indica se o usuário tem restrição de horário. | Não | 'nao' | | tempoil | varchar(5) | Tempo inicial de login (formato HH:MM, se aplicável). | Não | "08:00" | | tempofl | varchar(5) | Tempo final de login (formato HH:MM, se aplicável). | Não | "18:00" | | ativo | enum('sim','nao') | Status de ativação do usuário. | Não | 'sim' | | key_onetime | varchar(16) | Chave one-time (para autenticação temporária). | Não | NULL | | cli_grupos | varchar(255) | Grupos de clientes associados (ex: 'full_clientes'). | Não | 'full_clientes' | ### Exemplo de Corpo JSON ``` json { "login": "novo_usuario", "sha": "e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4", // Exemplo de hash SHA-1 para "senha123" "email": "novo@exemplo.com", "nivel": "admin", "nome": "Novo Usuário", "horario": "sim", "tempoil": "09:00", "tempofl": "17:00", "ativo": "sim" } ``` ## Respostas Esperadas ### Sucesso (200 OK) - **Descrição**: Usuário inserido com sucesso. - **Corpo JSON**: ``` json { "status": "sucesso", "mensagem": "Usuário inserido com sucesso", "dados": { "idacesso": 123, // ID gerado "uuid": "exemplo-uuid-gerado", // Opcional, se o sistema gerar UUID "login": "novo_usuario" } } ``` ## Exemplo de Requisição no Postman - **URL**: `https://{{IP_MK-AUTH}}/api/usuario/inserir` (substitua `{{IP_MK-AUTH}}` pela URL do seu sistema). - **Método**: POST - **Headers**: - Authorization: Bearer {{TokenJWT}} - **Body**: Raw JSON (como no exemplo acima). ## Observações Adicionais - **Segurança**: Certifique-se de usar HTTPS para proteger senhas e dados sensíveis. tags: - Usuario responses: '200': description: '' parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} requestBody: content: text/plain: schema: type: string /api/usuario/listar/pagina=1: get: summary: Listar operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_usuario_listar_yml description: >- #### Endpoint: api/usuario/listar ##### Método: GET **Descrição**: Retorna uma lista de usuarios no formato JSON. **Paginação** A paginação é iniciada na página 1 por padrão. Para navegar entre os registros, o total de páginas é incluído no corpo da resposta, auxiliando na navegação. | Parâmetros de consulta | Descrição | Exemplo | | --- | --- | --- | | `pagina:` | Paginação para navegar entre os registros.(pagina padrão 1). | /listar/pagina=2 | | `limite:` | Quantidade de registros que serão retornados (limite maximo 500 padrão) _parâmetro opcional_ | /listar/pagina=9&limite=150 | **Filtro para consulta** Este endpoint aceita parâmetros para filtrar os resultados. Após api/usuario/listar, adicione uma barra **`/`** e os parâmetros desejados. | Observação | Exemplo | | --- | --- | | Todos os parâmetros retornados na resposta **"usuarios":** deste endpoint podem ser utilizados para filtrar os resultados da consulta, separando-os com **`&`**. | listar/login=login | tags: - Usuario responses: '200': description: '200' content: application/json: schema: type: object properties: total_registros: type: number consulta_atual: type: number pagina_atual: type: number total_paginas: type: number usuarios: type: array items: type: string properties: '0': type: object properties: uuid: type: string login: type: string email: type: string avatar: type: string ultacesso: type: string nivel: type: string '1': type: object properties: uuid: type: string login: type: string email: type: string avatar: type: string ultacesso: type: string nivel: type: string example: total_registros: 4 consulta_atual: 2 pagina_atual: 1 total_paginas: 2 usuarios: - uuid: 7c8c5384-bc5f-11ee-95e4-080027c29949 login: admin email: admin@mk-auth.com.br avatar: user.gif ultacesso: 30/01 07:57 nivel: 21232f297a57a5a743894a0e4a801fc3 - uuid: B4CB337C-AFB2-4BBE-B7DF-D338FB5B1667 login: Curie email: Marie1867@gmail.com avatar: user.gif ultacesso: 20/12 12:01 nivel: ab61ebd2184e91003ab77c8c16681bdb parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/usuario/F8C18DDF-AFC7-48C0-875A-A3251412D4F9: delete: summary: Remover operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_usuario_remover_yml description: >- #### Endpoint: api/usuario/{uuid do usuario} ##### Método: DELETE **Descrição**: Deleta um usuario específico passando o UUID no parâmetro da URL. tags: - Usuario responses: '200': description: '200' content: application/json: schema: type: object properties: status: type: string mensagem: type: string example: status: sucesso mensagem: Registro excluido com sucesso parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} /api/usuario/show/curie: get: summary: Show operationId: c_users_pedrofilho_documents_bruno_mk-auth_api_usuario_show_yml description: >- #### Endpoint: api/usuario/show/{uuid do usuario} ##### Método: GET **Descrição**: Retorna os detalhes de um usuario específica em formato JSON. tags: - Usuario responses: '200': description: '200' content: application/json: schema: type: object properties: uuid_acesso: type: string nome: type: string login: type: string email: type: string avatar: type: string ultacesso: type: string nivel: type: string example: uuid_acesso: B4CB337C-AFB2-4BBE-B7DF-D338FB5B1667 nome: Marie Curie login: Curie email: Marie1867@gmail.com avatar: user.gif ultacesso: 20/12 12:01 nivel: ab61ebd2184e91003ab77c8c16681bdb parameters: - name: Authorization in: header description: '' required: true schema: type: string example: Bearer {{TokenJWT}} servers: - url: https://10.20.30.2 - url: http://10.20.30.2 components: schemas: editar: type: object properties: nome: type: string titulo: type: string descricao: type: string tipo: type: string valor: type: string velup: type: string veldown: type: string prioridade: type: string inserir: type: object properties: nome: type: string titulo: type: string descricao: type: string tipo: type: string valor: type: string velup: type: string veldown: type: string prioridade: type: string fechar: type: object properties: motivo: type: string chamado: type: string estornar: type: object properties: uuid: type: string liquidar: type: object properties: uuid: type: string valorpago: type: number quantidade: type: object properties: uuid: type: string estoque: type: number dados: type: object properties: nome: type: string responsavel: type: string cargo: type: string razao: type: string cnpj: type: string endereco: type: string numero: type: string bairro: type: string cidade: type: string cidade_ibge: type: string estado: type: string cep: type: string telefone: type: string fax: type: string celular: type: string email: type: string site: type: string id: type: number redes: type: object properties: id: type: number whatsapp: type: string facebook: type: string twitter: type: string tiktok: type: string instagram: type: string youtube: type: string telegram: type: string skype: type: string kwai: type: string linkedin: type: string enviar_email: type: object properties: login: type: string assunto: type: string mensagem: type: string enviar_sms: type: object properties: login: type: string mensagem: type: string enviar_zap_imagem: type: object properties: tipo: type: number login: type: string img_legenda: type: string img_base64: type: string enviar_zap_pdf: type: object properties: tipo: type: number login: type: string pdf_legenda: type: string pdf_nome: type: string pdf_base64: type: string enviar_zap: type: object properties: tipo: type: number login: type: string mensagem: type: string turbo: type: object properties: garup: type: string gardown: type: string maxup: type: string maxdown: type: string desaup: type: string desadown: type: string tempoup: type: string tempodown: type: string uuid: type: string receber: type: object properties: coletor: type: string valor: type: string forma: type: string uuid: type: string titulos_1: type: object properties: login: type: array items: type: string properties: '0': type: string cpf_cnpj: type: array items: type: string properties: '0': type: string '1': type: string status: type: string requestBodies: editar: content: application/json: schema: $ref: '#/components/schemas/editar' description: '' required: true inserir: content: application/json: schema: $ref: '#/components/schemas/inserir' description: '' required: true fechar: content: application/json: schema: $ref: '#/components/schemas/fechar' description: '' required: true estornar: content: application/json: schema: $ref: '#/components/schemas/estornar' description: '' required: true liquidar: content: application/json: schema: $ref: '#/components/schemas/liquidar' description: '' required: true quantidade: content: application/json: schema: $ref: '#/components/schemas/quantidade' description: '' required: true dados: content: application/json: schema: $ref: '#/components/schemas/dados' description: '' required: true redes: content: application/json: schema: $ref: '#/components/schemas/redes' description: '' required: true enviar_email: content: application/json: schema: $ref: '#/components/schemas/enviar_email' description: '' required: true enviar_sms: content: application/json: schema: $ref: '#/components/schemas/enviar_sms' description: '' required: true enviar_zap_imagem: content: application/json: schema: $ref: '#/components/schemas/enviar_zap_imagem' description: '' required: true enviar_zap_pdf: content: application/json: schema: $ref: '#/components/schemas/enviar_zap_pdf' description: '' required: true enviar_zap: content: application/json: schema: $ref: '#/components/schemas/enviar_zap' description: '' required: true turbo: content: application/json: schema: $ref: '#/components/schemas/turbo' description: '' required: true receber: content: application/json: schema: $ref: '#/components/schemas/receber' description: '' required: true titulos_1: content: application/json: schema: $ref: '#/components/schemas/titulos_1' description: '' required: true securitySchemes: basic_auth: type: http scheme: basic