Nome ou parte do nome do agente
Cedente Api (v1.0.0)
A API Cedente foi desenvolvida para oferecer um controle abrangente e eficiente sobre o gerenciamento de cedentes no sistema. Com ela, é possível realizar operações completas de CRUD (Create, Read, Update, Delete) para cedentes, incluindo funcionalidades avançadas de filtragem por diversos critérios como nome, apelido, status, visibilidade, grupos empresariais e políticas de limites. Esta API também permite a consulta de cedentes vinculados a agentes específicos e a recuperação de cedentes ativos, garantindo flexibilidade e precisão no acesso aos dados.
Simplificando o gerenciamento de cedentes com o poder e a flexibilidade de uma API de alta performance!
A seguir, detalhamos as principais funcionalidades oferecidas por cada um dos endpoints.
Download OpenAPI description
Overview
rgbtec
Languages
Servers
Mock server
https://apidocs.ger26.com.br/_mock/api_cedentes_extend
http://rgbsys.dyndns.info/ger2025-cedente-api-desenvolvimento
Este conjunto de recursos permite a manipulação e consulta de dados de agentes no sistema:
- Cadastrar Agente:
- Cria um novo agente no sistema com todas as informações necessárias.
- Alterar Agente:
- Atualiza os dados de um agente existente pelo seu identificador.
- Listar Agentes:
- Recupera todos os agentes com opções de filtragem por nome, nível, status, e outras propriedades, além de paginação.
- Listar Agentes de uma Política de Comissão:
- Recupera todos os agentes vinculados a uma política de comissão específica.
- Listar Agentes Ativos:
- Recupera somente os agentes que estão ativos no sistema.
- Consultar Agente por ID:
- Busca um agente específico pelo seu identificador único.
- Excluir Agente:
- Remove um agente do sistema pelo seu identificador.
- Alterar Política de Comissão de Agente:
- Atualiza a política de comissão vinculada a um agente específico.
Operations
- Mock serverhttps://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/agentes
- http://rgbsys.dyndns.info/ger2025-cedente-api-desenvolvimento/api/v1/agentes
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/agentes?quantidade=10&ascendente=true'Response
application/json
[ { "id": "string", "nome": "string", "nivel": 0, "status": 0, "whatsapp": "string", "possuiEmail": true, "possuiEndereco": true, "possuiDadoBancario": true } ]
Bodyrequired
- application/json
- application/*+json
Dados da pessoa fisica + usuário
Array de Telefones do Usuário
Array de E-mails do Usuário
Array com Endereços do Usuário
Array com Acessos do Usuário
Número da Identidade do Usuário
Dados bancários do cedente
Informações da Agência
Informações da Conta
- Mock serverhttps://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/agentes
- http://rgbsys.dyndns.info/ger2025-cedente-api-desenvolvimento/api/v1/agentes
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- application/json
- application/*+json
curl -i -X POST \
https://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/agentes \
-H 'Content-Type: application/json' \
-d '{
"tipoPessoa": 0,
"pessoaFisica": {
"cpf": "string",
"telefones": [
{
"numero": "string",
"tipo": 0,
"principal": true,
"whatsapp": true,
"sms": true
}
],
"emails": [
{
"email": "string",
"principal": true
}
],
"enderecos": [
{
"logradouro": "string",
"numero": "string",
"semNumero": true,
"complemento": "string",
"cep": "string",
"bairro": "string",
"municipio": "string",
"uf": "string",
"principal": true
}
],
"acessos": [
{
"empresaId": "string",
"tipoPessoaFisica": 0,
"ativo": true
}
],
"setorIds": [
"string"
],
"cargoIds": [
"string"
],
"nome": "string",
"login": "string",
"perfilsId": [
"string"
],
"identidade": {
"numero": "string",
"emissao": "2019-08-24T14:15:22Z"
},
"nascimento": "2019-08-24T14:15:22Z",
"site": "string",
"tipoAutenticacaoDoisFatores": [
0
]
},
"cnpj": "string",
"dadosBancarios": [
{
"tipoConta": 0,
"bancoId": 0,
"agencia": {
"numero": "string",
"digito": "string"
},
"conta": {
"numero": "string",
"digito": "string"
},
"principal": true,
"chavesPix": [
{
"tipo": 0,
"chave": "string"
}
]
}
],
"emails": [
null
],
"telefones": [
null
],
"enderecos": [
null
],
"apelido": "string",
"comissao": 0.1,
"status": 0,
"nivelHierarquico": 0,
"agentesAssociados": [
"string"
],
"usuarioIdAcessoSistema": "string",
"politicaComissaoAgenteId": "string",
"cedentes": [
"string"
],
"usuariosVisaoCarteira": [
"string"
]
}'- Mock serverhttps://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/gerencial/politicas/comissoes-agentes/{id}/agentes
- http://rgbsys.dyndns.info/ger2025-cedente-api-desenvolvimento/api/v1/gerencial/politicas/comissoes-agentes/{id}/agentes
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/gerencial/politicas/comissoes-agentes/{id}/agentes?quantidade=10&ascendente=true'Response
application/json
[ { "id": "string", "nome": "string", "nivel": 0, "status": 0, "whatsapp": "string", "possuiEmail": true, "possuiEndereco": true, "possuiDadoBancario": true } ]
- Mock serverhttps://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/agentes/ativos
- http://rgbsys.dyndns.info/ger2025-cedente-api-desenvolvimento/api/v1/agentes/ativos
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/agentes/ativos?quantidade=10'Response
application/json
[ { "id": "string", "nome": "string", "apelido": "string", "nivel": 0, "politicaComissaoAgenteId": "string" } ]
- Mock serverhttps://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/agentes/{id}
- http://rgbsys.dyndns.info/ger2025-cedente-api-desenvolvimento/api/v1/agentes/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/agentes/{id}'OK
Array de agentes associados
Politica de comissao do agente
Dados do usuário
Perfis associados ao usuário
Identidade do usuário
Tipo de autenticação dois fatores
Telefones do usuário
Emails do usuário
Endereços do usuário
Acessos do usuário
Setores do usuário
Usuários com acesso ao sistema
Dados da pessoa física
Dados da pessoa jurídica
Situação cadastral da pessoa jurídica
Endereço da Receita Federal da pessoa jurídica
Indica se o endereço não possui número
Complemento do endereço da pessoa
Município do endereço da pessoa
Número de Inscrição do Registro de Empresas (NIRE) da pessoa jurídica
Tipo de regime tributário da pessoa jurídica
Registro na Junta Comercial da pessoa jurídica
CNAEs da pessoa jurídica
Data da última atualização na Receita Federal
Lista de Dados Bancários do cedente
Informações do banco
Informações da agência
Informações da conta
Lista de chaves PIX associadas à conta
Response
application/json
{ "apelido": "string", "status": 0, "nivelHierarquico": 0, "comissao": 0.1, "agentesAssociados": [ { … } ], "politicaComissaoAgente": { "id": "string", "nome": "string" }, "usuario": { "id": "string", "nome": "string", "cpf": "string", "login": "string", "perfis": [ … ], "identidade": { … }, "nascimento": "2019-08-24T14:15:22Z", "site": "string", "tipoAutenticacaoDoisFatores": 0, "telefones": [ … ], "emails": [ … ], "enderecos": [ … ], "acessos": [ … ], "setores": [ … ], "cargos": [ … ] }, "usuariosAcessoSistema": [ { … } ], "usuariosVisaoCarteira": [ null ], "pessoaFisica": { "identidade": "string", "emissaoIdentidade": "2019-08-24T14:15:22Z", "nascimento": "2019-08-24T14:15:22Z", "id": "string", "cpf": "string", "nome": "string", "site": "string" }, "pessoaJuridica": { "pessoaId": "string", "cnpj": "string", "abertura": "2019-08-24T14:15:22Z", "nomeEmpresarial": "string", "nomeFantasia": "string", "naturezaJuridica": "string", "situacaoCadastral": { … }, "inscricaoEstadual": "string", "inscricaoMunicipal": "string", "enderecoReceitaFederal": { … }, "matriz": true, "nire": "string", "site": "string", "tipoRegimeTributario": "string", "tipoPessoaJuridica": "string", "registroJuntaComercial": "string", "cnaes": [ … ], "ultimaAtualizacaoReceitaFederal": "2019-08-24T14:15:22Z", "statusSincronizacao": 0, "mensagemErroSincronizacao": "string" }, "emails": [ null ], "enderecos": [ null ], "telefones": [ null ], "dadosBancarios": [ { … } ] }
Bodyrequired
- application/json
- application/*+json
Dados da pessoa física
Data da emissão da identidade da pessoa física
Dados bancários do agente
Informações da Agência
Informações da Conta
Array de chaves Pix
Emails da empresa
Telefones da empresa
Endereços da empresa
- Mock serverhttps://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/agentes/{id}
- http://rgbsys.dyndns.info/ger2025-cedente-api-desenvolvimento/api/v1/agentes/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- application/json
- application/*+json
curl -i -X PUT \
'https://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/agentes/{id}' \
-H 'Content-Type: application/json' \
-d '{
"pessoaFisica": {
"nome": "string",
"identidade": "string",
"emissaoIdentidade": "2019-08-24T14:15:22Z",
"nascimento": "2019-08-24T14:15:22Z",
"site": "string"
},
"dadosBancarios": [
{
"id": "string",
"tipoConta": 0,
"bancoId": 0,
"agencia": {
"numero": "string",
"digito": "string"
},
"conta": {
"numero": "string",
"digito": "string"
},
"principal": true,
"chavesPix": [
{
"id": "string",
"tipo": 0,
"chave": "string"
}
]
}
],
"emails": [
{
"id": "string",
"email": "string",
"principal": true
}
],
"telefones": [
{
"id": "string",
"numero": "string",
"tipo": 0,
"principal": true,
"whatsapp": true,
"sms": true
}
],
"enderecos": [
{
"id": "string",
"logradouro": "string",
"numero": "string",
"semNumero": true,
"complemento": "string",
"cep": "string",
"bairro": "string",
"municipio": "string",
"uf": "string",
"principal": true
}
],
"usuariosAcesso": [
"string"
],
"apelido": "string",
"comissao": 0.1,
"status": 0,
"nivelHierarquico": 0,
"agentesAssociados": [
"string"
],
"usuarioIdAcessoSistema": "string",
"politicaComissaoAgenteId": "string",
"cedentes": [
"string"
],
"usuariosVisaoCarteira": [
"string"
]
}'- Mock serverhttps://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/agentes/{id}
- http://rgbsys.dyndns.info/ger2025-cedente-api-desenvolvimento/api/v1/agentes/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/agentes/{id}'- Mock serverhttps://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/agentes/{id}/politicas/comissoes-agentes
- http://rgbsys.dyndns.info/ger2025-cedente-api-desenvolvimento/api/v1/agentes/{id}/politicas/comissoes-agentes
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- application/json
- application/*+json
curl -i -X PATCH \
'https://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/agentes/{id}/politicas/comissoes-agentes' \
-H 'Content-Type: application/json' \
-d '{
"id": "string",
"politicaComissaoAgenteId": "string"
}'Response
application/json
{ "politicaComissaoAgenteId": "string" }
Este conjunto de recursos permite a manipulação e consulta de dados de cedentes no sistema:
- Cadastrar Cedente:
- Cria um novo cedente no sistema.
- Alterar Cedente:
- Atualiza os dados de um cedente existente pelo seu identificador.
- Listar Cedentes:
- Recupera todos os cedentes com opções de filtragem por nome, apelido, status, visibilidade, grupo empresarial, política de limites e paginação.
- Listar Cedentes do Agente:
- Recupera todos os cedentes vinculados a um agente específico.
- Listar Cedentes Ativos:
- Recupera somente os cedentes que estão ativos no sistema.
- Consultar Cedente por ID:
- Busca um cedente específico pelo seu identificador único.
- Excluir Cedente:
- Remove um cedente do sistema pelo seu identificador.
Operations