Introdução
Bem-vindo a documentação da API RadiusNet! Você pode utilizar nossa API para acessar os endpoints do RadiusNet e obter diversas informações do sistema bem como executar algumas funções.
Autenticação
Para autorização de todos os endpoint disponíveis será necessário o envio do parâmetro de autorização(RTOKEN), conforme abaixo:
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/END_POINT" -H "RTOKEN: CHAVE_API"
Certifique-se de substituir
CHAVE_APIpela sua chave de autorização e IP_RADIUSNET pelo IP de seu RadiusNet.
O RadiusNet utiliza chaves de autorização para permitir o acesso autorizado à API. Você pode obter uma chave de API para seu RadiusNet gerando-a em seu sistema RadiusNet, no menu: Cadastros >> Empresas >> (Aba)API RadiusNet..
O RadiusNet espera que a chave de autorização seja incluída no cabeçalho de todas as requisições da API, semelhante ao seguinte:
Request Headers
rtoken: 5de728362beedd39e41f0...[]
Limites de Requisições
Cada RTOKEN pode realizar uma quantidade maxima de requisições por minuto. O número de requisições feitas pelo RTOKEN é zerada a cada minuto.
A cada requisição realizada, o servidor retorna os cabeçalhos X-RateLimit-Limit e X-RateLimit-Remaining com o número de requisições permitidas e o número de requisições restantes para a referido minuto.
EXEMPLO DE CABEÇALHO RESPOSTA EM CASO DE SUCESSO:
HTTP/1.1 200 OK
Date: Fri, 05 Nov 2010 12:00:00 GMT
Content-Type: application/json; charset=utf-8
X-RateLimit-Limit: 500
X-RateLimit-Remaining: 486
Caso atinja o número máximo de requisições dentro de um minuto, o servidor retorna o status
HTTP 429 Too Many Requests. Neste caso, você deve esperar o número de segundos retornado no header X-Retry-After antes de realizar a próxima requisição com sucesso.
EXEMPLO DE CABEÇALHO RESPOSTA EM CASO DE BLOQUEIO:
HTTP/1.1 429 Too Many Requests
Date: Fri, 05 Nov 2010 12:00:00 GMT
Content-Type: application/json; charset=utf-8
X-RateLimit-Limit: 500
X-RateLimit-Remaining: 0
X-Retry-After: 45
ENDPOINTS
1. (v1/cp) Obter planos do cliente por CPF-CNPJ.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/cp/CPF_CNPJ/ID_STATUS_PLANO" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [ { "id_cliente": "151", "nome_razao": "NOME COMPLETO CLIENTE", "cpf_cnpj": "99999999999", "rg": "", "data_nascimento": "1972-12-15", "data_cadastro": "2021-05-07 13:00:00", "id_status_cliente": "2", "identificador": "8888888888888", "status_cliente": "Avisado", "id_tipo_pagamento_cliente": "1", "tipo_pagamento_cliente": "Boleto", "isBoletoFacil": "0", "isIugu": "0", "isGerenciaNet": "1", "nome_boleto": null, "senha_central_md5": null, "planos": [ { "id_cliente_plano": "150", "id_end_instalacao": "167", "endereco_instalacao": "Rua Teste Resultado, 0, - Vila do Equador - Rorainópolis/RR CEP: 69000000", "id_end_cobranca": "167", "endereco_cobranca": "Rua Teste Resultado, 0, - Vila do Equador - Rorainópolis/RR CEP: 69000000", "plano": "BANDA LARGA 100 MEGAS FIBRA OPTICA", "id_plano": "20", "grupo_plano": "Vila do Equador", "id_status_plano": "2", "status_plano": "Ativo", "id_venc": "10", "dia_vencimento": "10", "valor_plano": "180.00", "valor_plano_ate_vencimento": "0.00", "login": "usuario_pppoe", "senha": "123", "mac_cadastro": "", "ddns": null, "wireless_psk": "", "nao_bloquear_ate": null, "data_ativacao": "2021-05-07 12:00:00", "isento": "0", "observacao": "", "tipo_plano": "", "id_tipo_plano": "1", "regiao_com_problema": "Sim", "franquia_ultrapassada": false, "info_franquia_ultrapassada": null, "motivo_problema_regiao": { "id_motivo_problema_regiao": "1", "descricao": "Rompimento de Fibra", "data_retorno": "16/01/2025", "hora_retorno": "19", "minuto_retorno": "00" } } ], "emails": [ { "email": "cliente@email.com.br" }, { "email": "cliente@email2.com.br" } ], "telefones": [ { "ddd": "19", "telefone": "88888888" }, { "ddd": "19", "telefone": "99999999" } ], "statusRoteador": { "status": "Offline", "Ip": "Offline" } } ], "count": 1 }
Este endpoint recupera todos os planos do cliente vinculados ao CPF-CNPJ informado como parâmetro desta API, caso informe o parametro ID_STATUS_PLANO, serão retornados apenas os planos provenientes do ID_STATUS_PLANO informado, caso não informado, todos os planos serão retornados independente de seu status.
Nota Importante: Este endpoint agora inclui as informações de regiões com problema, contendo o motivo do problema.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/cp/CPF_CNPJ/ID_STATUS_PLANO
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| CPF_CNPJ | Path | Sim | CPF ou CNPJ(somente números) do Cliente que deseja realizar a consulta de planos. |
| ID_STATUS_PLANO | Path | Não | Código identificador de status dos planos(somente números 1 a 5, conforme tabela abaixo). |
| Valores para ID_STATUS_PLANO | Descrição |
|---|---|
| 1 | Pendente - Plano aguardando ativação. |
| 2 | Ativo - Plano já ativado. |
| 3 | Inativo - Plano inativo. |
| 4 | Pré-Ativo - Plano aguardando ativação (disponível apenas para ativação através da Central do Técnico - CDT). |
| 5 | Listar Todos os registros independente de seu status. |
| não informado | Por padrão, os registros com status "Inativo" não serão listados |
2. (v1/cbp/) Obter cobranças do plano.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/cbp/FILTRO/ID_CLIENTE_PLANO" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
============== /v1/cbp/np/ ============== { "rows": [{ "itensPlano": [{ "id_cobranca_plano": "80427", "valor": "114.90", "acrescimo": null, "desconto": null, "juros": "1.00", "multa": "2.00", "valor_pago": null, "valor_ate_vencimento": null, "plano": "10 MEGA PERMUTA - FIBRA OPTICA", "juros_pagar": 0, "multa_pagar": 0, "valor_atualizado": "114.90" },{ "id_cobranca_plano": "80451", "valor": "199.90", "acrescimo": null, "desconto": null, "juros": "1.00", "multa": "2.00", "valor_pago": null, "valor_ate_vencimento": null, "plano": "30 MEGA SIMETRICO PERMUTA - FIBRA OPTICA", "juros_pagar": 0, "multa_pagar": 0, "valor_atualizado": "199.90" }], "itensAvulsa": [], "valor_pago_cobranca": "0.00", "id_cliente_plano": "447", "pago": "0", "id_cobranca": "7387143", "periodo_prestacao": "12/2019", "data_vencimento": "2020-01-10", "desconto_ate_vencimento": "20.00", "data_vencimento_util": "2020-01-10", "valor_total_a_pagar": "294.80", "valor_total_cobranca": 314.80, "isGerenciaNet": "1", "isBoletoFacil": "0", "nosso_numero": null, "linha_digitavel": "99999.99999 99999.999999 99999.999999 3 81300000031480", "isVencido": false }], "count": 4 } ============== /v1/cbp/at/ ============== { "rows": [{ "itensPlano": [{ "id_cobranca_plano": "80413", "valor": "114.90", "acrescimo": null, "desconto": null, "juros": "1.00", "multa": "2.00", "valor_pago": null, "valor_ate_vencimento": null, "plano": "10 MEGA PERMUTA - FIBRA OPTICA", "juros_pagar": "0.15", "multa_pagar": "2.30", "valor_atualizado": "117.35" }, { "id_cobranca_plano": "80437", "valor": "199.90", "acrescimo": null, "desconto": null, "juros": "1.00", "multa": "2.00", "valor_pago": null, "valor_ate_vencimento": null, "plano": "30 MEGA SIMETRICO PERMUTA - FIBRA OPTICA", "juros_pagar": "0.27", "multa_pagar": "4.00", "valor_atualizado": "204.17" }], "itensAvulsa": [], "valor_pago_cobranca": "0.00", "id_cliente_plano": "447", "pago": "0", "id_cobranca": "7387129", "periodo_prestacao": "05/2019", "data_vencimento": "2019-06-06", "desconto_ate_vencimento": "20.00", "data_vencimento_util": "2019-06-06", "valor_total_a_pagar": "301.52", "valor_total_cobranca": 321.52, "isGerenciaNet": "1", "isBoletoFacil": "0", "nosso_numero": null, "linha_digitavel": "99999.99999 99999.999999 99999.999999 1 79920000043887", "isVencido": true, "promessa_pagamento": true }], "count": 1 } ============== /v1/cbp/pg/ ============== { "rows": [{ "itensPlano": [{ "id_cobranca_plano": "6597", "valor": "99.90", "acrescimo": null, "desconto": null, "juros": "1.00", "multa": "2.00", "valor_pago": "99.90", "valor_ate_vencimento": null, "plano": "10 MEGA PERMUTA - FIBRA OPTICA" }], "itensAvulsa": [], "valor_pago_cobranca": "79.90", "id_cliente_plano": "447", "pago": "1", "id_cobranca": "7308112", "periodo_prestacao": "03/2016", "data_vencimento": "2016-04-10", "desconto_ate_vencimento": "20.00", "data_vencimento_util": "2016-04-11", "valor_total_a_pagar": "79.90", "valor_total_cobranca": 99.90, "isGerenciaNet": "0", "isBoletoFacil": "0", "nosso_numero": "7308112", "data_pagamento": "2016-04-05" }], "count": 1 }
Este endpoint recupera as cobranças do cliente/plano.
Serão retornadas as cobranças do cliente/plano conforme as seguintes situações em que elas se encontram:
Cobranças do cliente/plano não pagas: serão retornadas apenas as cobranças disponíveis para pagamento, ou seja, essas devem estar devidamente vinculadas a um método de pagamento, Boleto com Registro, Gerencianet, Boleto Fácil, Cobrança Interna, etc.
Caso o
ID_CLIENTE_PLANOinformado no parâmetro desta API possua cobranças, mas estas não estejam devidamente vinculadas a um método de pagamento, elas não serão retornadas nesta consulta.Cobranças do cliente/plano pagas: serão retornadas todas as cobranças pagas de planos pertencentes ao
ID_CLIENTE_PLANOinformado no parâmetro desta API.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/cbp/FILTRO/ID_CLIENTE_PLANO
Parâmetros
| Parâmetro | Tipo | Obrigátório | Descrição |
|---|---|---|---|
| RTOKEN | Header Params | Sim | Chave de autorização para acesso a API. |
| FILTRO | Path Params | Sim | Identificação do Filtro de listagem das cobranças(tabela abaixo). |
| ID_CLIENTE_PLANO | Path Params | Sim | Código de identificação do cliente/plano que deseja realizar a consulta de cobranças. |
| Filtros Disponíveis | Descrição |
|---|---|
| np | Cobranças do cliente/plano não pagas - todas as cobranças não pagas. |
| at | Cobranças do cliente/plano não pagas - apenas as cobranças em atraso. |
| pg | Cobranças do cliente/plano pagas - todas as cobranças pagas. |
3. (v1/bc) Obter boleto(PDF) da cobrança
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/bc/ID_COBRANCA" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": "http://IP_RADIUSNET/other/downloads/boletos/9b45de74/Boletos_1a471a5d.pdf", "count": 1 }
Este endpoint recupera o boleto(PDF) da cobrança informada.
Será retornada apenas o boleto da cobrança disponível para pagamento, ou seja, esta deve estar devidamente vinculada a um método de pagamento, Boleto com Registro, Gerencianet, Boleto Fácil, Cobrança Interna, etc.
Caso o ID_COBRANCA informado no parâmetro desta API não esteja devidamente vinculada a um método de pagamento, ela não será retornada nesta consulta.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/bc/ID_COBRANCA
Parâmetros
| Parâmetro | Tipo | Obrigátório | Descrição |
|---|---|---|---|
| RTOKEN | Header Params | Sim | Chave de autorização para acesso a API. |
| ID_COBRANCA | Path Params | Sim | Código de identificação da cobrança que deseja realizar a geração do boleto(PDF). |
4. (v1/ppg) Promessa de pagamento de cobrança
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/ppg/ID_COBRANCA" -X PUT -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows":{"success":true, "msg":"Operação realizada com sucesso!"}, "count":2 }
Este endpoint realiza a promessa de pagamento da cobrança em atraso informada como parâmetro desta ação.
Caso a cobrança(ID_COBRANCA) informada no parâmetro desta ação, não esteja devidamente vinculada a um método de pagamento, a ação de promessa de pagamento não será realizada! Certifique-se de que a referida cobrança esteja devidamente vinculada a um método de pagamento antes de utilizar o recurso de promessa de pagamento.
Este endpoint tem o objetivo de realizar a alteração de status do cliente para avisado, caso este esteja com status bloqueado, realizando assim a liberação da velocidade integral de navegação do plano do cliente. Esta liberação valerá até o prazo de dias configurado no campo "Quantidade dias para status avisado quando imprimir um boleto vencido ou Promessa de Pagamento na CDA/API", disponível no menu do RadiusNet em: Administração >> Configurações >> Financeiro;
Caso o retorno da liquidação do pagamento não seja realizado até o prazo informado no campo "Quantidade dias para status avisado quando imprimir um boleto vencido ou Promessa de Pagamento na CDA/API" o cliente volta a ser bloqueado e não será mais beneficiado por este desbloqueio automático em uma posterior promessa de pagamento por API.
Method
PUT
Solicitação HTTP
PUT http://IP_RADIUSNET/radiusnet/index.php/api/v1/ppg/ID_COBRANCA
Parâmetros
| Parâmetro | Tipo | Obrigátório | Descrição |
|---|---|---|---|
| RTOKEN | Header Params | Sim | Chave de autorização para acesso a API. |
| ID_COBRANCA | Path Params | Sim | Código de identificação da cobrança que deseja realizar a promessa de pagamento. |
5. (v1/cba/) Obter cobranças avulsas do cliente.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/cba/FILTRO/ID_CLIENTE" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
============== /v1/cbp/pg/ ============== { "rows": [ { "data_pagamento": "2019-08-28", "data_vencimento": "2019-08-28", "data_vencimento_util": "2019-08-28", "id_cobranca": "65096", "isBoletoFacil": "0", "isGerenciaNet": "0", "itensAvulsa": [ { "acrescimo": null, "desconto": null, "id_cobranca_avulsa": "2420", "juros": null, "multa": null, "tipo_cobranca_avulsa": "Taxa de instalação", "valor": "0.01", "valor_pago": "0.01" } ], "nosso_numero": null, "pago": "1", "valor_pago_cobranca": "0.01", "valor_total_a_pagar": "0.01", "valor_total_cobranca": "0.01" } ], "count": 1 } ============== /v1/cba/at/ ============== { "rows": [ { "data_vencimento": "2019-08-04", "data_vencimento_util": "2019-08-05", "id_cobranca": "65118", "isBoletoFacil": "0", "isGerenciaNet": "0", "isVencido": true, "itensAvulsa": [ { "acrescimo": null, "desconto": null, "id_cobranca_avulsa": "2433", "juros": "0.00", "juros_pagar": "0.00", "multa": "0.00", "multa_pagar": "0.00", "tipo_cobranca_avulsa": "Taxa de instalação", "valor": "100.00", "valor_atualizado": "100.00", "valor_pago": null } ], "linha_digitavel": "34191.09008 01451.078156 82340.080009 1 79710000010000", "nosso_numero": "14510", "pago": "0", "promessa_pagamento": false, "valor_pago_cobranca": "0.00", "valor_total_a_pagar": "100.00", "valor_total_cobranca": "100.00" } ], "count": 1 } ============== /v1/cba/np/ ============== { "rows": [ { "data_vencimento": "2019-08-04", "data_vencimento_util": "2019-08-05", "id_cobranca": "65118", "isBoletoFacil": "0", "isGerenciaNet": "0", "isVencido": true, "itensAvulsa": [ { "acrescimo": null, "desconto": null, "id_cobranca_avulsa": "2433", "juros": "0.00", "juros_pagar": "0.00", "multa": "0.00", "multa_pagar": "0.00", "tipo_cobranca_avulsa": "Taxa de instalação", "valor": "100.00", "valor_atualizado": "100.00", "valor_pago": null } ], "linha_digitavel": "34191.09008 01451.078156 82340.080009 1 79710000010000", "nosso_numero": "14510", "pago": "0", "promessa_pagamento": false, "valor_pago_cobranca": "0.00", "valor_total_a_pagar": "100.00", "valor_total_cobranca": "100.00" } ], "count": 1 }
Este endpoint recupera as cobranças avulsas do cliente.
Serão retornadas as cobranças do cliente conforme as seguintes situações em que elas se encontram:
Cobranças do cliente não pagas: serão retornadas apenas as cobranças disponíveis para pagamento, ou seja, essas devem estar devidamente vinculadas a um método de pagamento, Boleto com Registro, Gerencianet, Boleto Fácil, Cobrança Interna, etc.
Caso o
ID_CLIENTEinformado no parâmetro desta API possua cobranças, mas estas não estejam devidamente vinculadas a um método de pagamento, elas não serão retornadas nesta consulta.Cobranças do cliente/plano pagas: serão retornadas todas as cobranças pagas de planos pertencentes ao
ID_CLIENTEinformado no parâmetro desta API.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/cba/FILTRO/ID_CLIENTE
Parâmetros
| Parâmetro | Tipo | Obrigátório | Descrição |
|---|---|---|---|
| RTOKEN | Header Params | Sim | Chave de autorização para acesso a API. |
| FILTRO | Path Params | Sim | Identificação do Filtro de listagem das cobranças(tabela abaixo). |
| ID_CLIENTE | Path Params | Sim | Código de identificação do cliente que deseja realizar a consulta de cobranças. |
| Filtros Disponíveis | Descrição |
|---|---|
| np | Cobranças do cliente não pagas - todas as cobranças não pagas. |
| at | Cobranças do cliente não pagas - apenas as cobranças em atraso. |
| pg | Cobranças do cliente pagas - todas as cobranças pagas. |
6. (v1/cbc/) Obter cobranças plano e cobranças avulsas do cliente.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/cbc/FILTRO/ID_CLIENTE" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
============== /v1/cbc/np/ ============== { "rows": [{ "itensPlano": [{ "id_cobranca_plano": "80427", "valor": "114.90", "acrescimo": null, "desconto": null, "juros": "1.00", "multa": "2.00", "valor_pago": null, "valor_ate_vencimento": null, "plano": "10 MEGA PERMUTA - FIBRA OPTICA", "juros_pagar": 0, "multa_pagar": 0, "valor_atualizado": "114.90" },{ "id_cobranca_plano": "80451", "valor": "199.90", "acrescimo": null, "desconto": null, "juros": "1.00", "multa": "2.00", "valor_pago": null, "valor_ate_vencimento": null, "plano": "30 MEGA SIMETRICO PERMUTA - FIBRA OPTICA", "juros_pagar": 0, "multa_pagar": 0, "valor_atualizado": "199.90" }], "itensAvulsa": [], "valor_pago_cobranca": "0.00", "id_cliente_plano": "447", "pago": "0", "id_cobranca": "7387143", "periodo_prestacao": "12/2019", "data_vencimento": "2020-01-10", "desconto_ate_vencimento": "20.00", "data_vencimento_util": "2020-01-10", "valor_total_a_pagar": "294.80", "valor_total_cobranca": 314.80, "isGerenciaNet": "1", "isBoletoFacil": "0", "nosso_numero": null, "linha_digitavel": "99999.99999 99999.999999 99999.999999 3 81300000031480", "isVencido": false }], "count": 4 } ============== /v1/cbc/at/ ============== { "rows": { "1": { "itensPlano": [], "itensAvulsa": [ { "id_cobranca_avulsa": "2433", "valor": "100.00", "acrescimo": null, "desconto": null, "juros": "0.00", "multa": "0.00", "valor_pago": null, "tipo_cobranca_avulsa": "Taxa de instalação", "juros_pagar": "0.00", "multa_pagar": "0.00", "valor_atualizado": "100.00" } ], "valor_pago_cobranca": "0.00", "id_cliente_plano": null, "pago": "0", "id_cobranca": "65118", "periodo_prestacao": "08/2019", "data_vencimento": "2019-08-04", "desconto_ate_vencimento": "0.00", "data_vencimento_util": "2019-08-05", "valor_total_a_pagar": "100.00", "valor_total_cobranca": "100.00", "isGerenciaNet": "0", "isBoletoFacil": "0", "nosso_numero": "14510", "registrada": "1", "linha_digitavel": "34191.09008 01451.078156 82340.080009 1 79710000010000", "promessa_pagamento": false, "isVencido": true } }, "count": 1 } ============== /v1/cbc/pg/ ============== { "rows": [ { "itensPlano": [], "itensAvulsa": [ { "id_cobranca_avulsa": "2420", "valor": "0.01", "acrescimo": null, "desconto": null, "juros": null, "multa": null, "valor_pago": "0.01", "tipo_cobranca_avulsa": "Taxa de instalação" } ], "valor_pago_cobranca": "0.01", "id_cliente_plano": null, "pago": "1", "id_cobranca": "65096", "periodo_prestacao": "08/2019", "data_vencimento": "2019-08-28", "desconto_ate_vencimento": "0.00", "data_vencimento_util": "2019-08-28", "valor_total_a_pagar": "0.01", "valor_total_cobranca": "0.01", "isGerenciaNet": "0", "isBoletoFacil": "0", "nosso_numero": null, "registrada": null, "data_pagamento": "2019-08-28" }, { "itensPlano": [ { "id_cobranca_plano": "62793", "valor": "0.00", "acrescimo": null, "desconto": null, "juros": "1.00", "multa": "2.00", "valor_pago": "0.00", "valor_ate_vencimento": null, "plano": "Cabo - 2 Megas", "prorata": "0" } ], "itensAvulsa": [], "valor_pago_cobranca": "0.00", "id_cliente_plano": "2891", "pago": "1", "id_cobranca": "65100", "periodo_prestacao": "08/2019", "data_vencimento": "2019-09-20", "desconto_ate_vencimento": "0.00", "data_vencimento_util": "2019-09-20", "valor_total_a_pagar": "0.00", "valor_total_cobranca": "0.00", "isGerenciaNet": "0", "isBoletoFacil": "0", "nosso_numero": null, "registrada": null, "data_pagamento": "2019-09-20" } ], "count": 2 ============== /v1/cbc/npt/ ============== "rows": [ { "itensPlano": [ { "id_cobranca_plano": "62792", "valor": "49.90", "acrescimo": "38.26", "desconto": null, "juros": "1.00", "multa": "2.00", "valor_pago": null, "valor_ate_vencimento": "79.50", "plano": "Cabo - 2 Megas", "prorata": "1", "juros_pagar": 0, "multa_pagar": 0, "valor_atualizado": "79.50" } ], "itensAvulsa": [ { "id_cobranca_avulsa": "2427", "valor": "10.00", "acrescimo": null, "desconto": null, "juros": "0.00", "multa": "0.00", "valor_pago": null, "tipo_cobranca_avulsa": "Cobrança Avulsa - Padrão", "juros_pagar": 0, "multa_pagar": 0, "valor_atualizado": "10.00" }, { "id_cobranca_avulsa": "2428", "valor": "20.00", "acrescimo": null, "desconto": null, "juros": "0.00", "multa": "0.00", "valor_pago": null, "tipo_cobranca_avulsa": "Visita técnica - mudança endereço", "juros_pagar": 0, "multa_pagar": 0, "valor_atualizado": "20.00" } ], "valor_pago_cobranca": "0.00", "id_cliente_plano": "2891", "pago": "0", "id_cobranca": "65099", "periodo_prestacao": "09/2019", "data_vencimento": "2019-10-20", "desconto_ate_vencimento": "8.66", "data_vencimento_util": "2019-10-21", "valor_total_a_pagar": "109.50", "valor_total_cobranca": "118.16", "isGerenciaNet": "0", "isBoletoFacil": "0", "nosso_numero": "14509", "registrada": "1", "linha_digitavel": "34191.09008 01450.998156 82340.080009 3 80480000011816", "isVencido": false }, { "itensPlano": [], "itensAvulsa": [ { "id_cobranca_avulsa": "2433", "valor": "100.00", "acrescimo": null, "desconto": null, "juros": "0.00", "multa": "0.00", "valor_pago": null, "tipo_cobranca_avulsa": "Taxa de instalação", "juros_pagar": "0.00", "multa_pagar": "0.00", "valor_atualizado": "100.00" } ], "valor_pago_cobranca": "0.00", "id_cliente_plano": null, "pago": "0", "id_cobranca": "65118", "periodo_prestacao": "08/2019", "data_vencimento": "2019-08-04", "desconto_ate_vencimento": "0.00", "data_vencimento_util": "2019-08-05", "valor_total_a_pagar": "100.00", "valor_total_cobranca": "100.00", "isGerenciaNet": "0", "isBoletoFacil": "0", "nosso_numero": "14510", "registrada": "1", "linha_digitavel": "34191.09008 01451.078156 82340.080009 1 79710000010000", "promessa_pagamento": false, "isVencido": true } ], "count": 2 }
Este endpoint recupera as cobranças do cliente.
Serão retornadas as cobranças do cliente conforme as seguintes situações em que elas se encontram:
Cobranças do cliente não pagas: serão retornadas apenas as cobranças disponíveis para pagamento, ou seja, essas devem estar devidamente vinculadas a um método de pagamento, Boleto com Registro, Gerencianet, Boleto Fácil, Cobrança Interna, etc.
Caso o
ID_CLIENTEinformado no parâmetro desta API possua cobranças, mas estas não estejam devidamente vinculadas a um método de pagamento, elas não serão retornadas nesta consulta.Cobranças do cliente pagas: serão retornadas todas as cobranças pagas de planos pertencentes ao
ID_CLIENTEinformado no parâmetro desta API.Cobranças do cliente em atraso: serão retornadas todas as cobranças que estão com o pagamento em atraso.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/cbc/FILTRO/ID_CLIENTE
Parâmetros
| Parâmetro | Tipo | Obrigátório | Descrição |
|---|---|---|---|
| RTOKEN | Header Params | Sim | Chave de autorização para acesso a API. |
| FILTRO | Path Params | Sim | Identificação do Filtro de listagem das cobranças(tabela abaixo). |
| ID_CLIENTE | Path Params | Sim | Código de identificação do cliente que deseja realizar a consulta de cobranças. |
| Filtros Disponíveis | Descrição |
|---|---|
| np | Cobranças do cliente não pagas - todas as cobranças não pagas e registradas. |
| npt | Cobranças do cliente não pagas - todas as cobranças não pagas registradas e não registradas. |
| at | Cobranças do cliente não pagas - apenas as cobranças em atraso e registradas. |
| att | Cobranças do cliente não pagas - apenas as cobranças em atraso, registradas e não registradas. |
| pg | Cobranças do cliente pagas - todas as cobranças pagas. |
7. (v1/lc/) Liquidar cobrança do cliente.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/lc/ID_COBRANCA/ID_CAIXA/ID_TIPO_PAGAMENTO" -X PUT -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows":{ "success":true, "msg":"Cobrança baixada com sucesso.", "nomeArquivo":"https://IP_RADIUSNET/other/downloads/recibo/recibo_1.odt" }, "count":3 }
Para ter acesso a esta liquidação via API será necessário atribuir a permissão no Radiusnet para "Liquidar cobranças via API". (Menu: Administração >> Configurações >> API).
Este endpoint terá como função a liquidação de cobranças.
As cobranças permititas à liquidação, são as retornadas nos endpoints de consulta de cobranças (v1/cbp/, v1/cba/, v1/cbc/) apresentadas nesta documentação. Também é necessaŕio que as cobranças estejam registradas juntamente ao seu banco ou sejam da modalidade cobranças internas, não devem ter vinculação a aplicações como GerenciaNet e Boleto Fácil(Juno), pois estas cobranças não podem ser liquidadas fora de seu roteiro estabelicido pelos seus respectivos emissores.
Além dos tipos de cobranças já citados, também é possível efetuar a liquidação de cobranças que não tem o nosso número. Ou seja, cobranças que foram pré criadas e que não foi definido nenhum tipo de pagamento ainda. Para retornar quais cobranças que não tenham o nosso número e que possam ser liquidadas, deverá ser usado o endpoint de consulta (v1/cbc/) e passar como FILTRO o valor npt a fim de listar todas as cobranças não pagas do cliente.
Para a liquidação da cobrança poderá ser informado o Caixa e Tipo de Pagamento, para consultar os Caixas e seus Tipos de pagamentos disponíveis consulte o endpoint (v1/tpc/) demonstrado neste documento Obter Caixa e Tipo de pagamento para liquidação da Cobrança.
Atenção:
Quando informados os parametros ID_CAIXA e ID_TIPO_PAGAMENTO para este endpoint, atente-se para que o Caixa e Tipo de Pagamento estejam vinculados no Radiusnet, caso seja informado a combinação incorreta de Tipo de pagamento do Caixa, o sistema irá realizar a liquidação utilizando os parametros informados como padrões para a liquidação de cobranças via API(Menu: Administração >> Configurações >> API).
Method
PUT
Solicitação HTTP
PUT http://IP_RADIUSNET/radiusnet/index.php/api/v1/lc/ID_COBRANCA/ID_CAIXA/ID_TIPO_PAGAMENTO
Exemplos de uso:
Exemplo 1: Apenas ID da Cobrança
PUT http://IP_RADIUSNET/radiusnet/index.php/api/v1/lc/12345
PUT http://IP_RADIUSNET/radiusnet/index.php/api/v1/lc/ID_COBRANCA
Exemplo 2: ID da Cobrança, ID do Caixa, ID do Tipo de Pagamento
PUT http://IP_RADIUSNET/radiusnet/index.php/api/v1/lc/12345/1/2
PUT http://IP_RADIUSNET/radiusnet/index.php/api/v1/lc/ID_COBRANCA/ID_CAIXA/ID_TIPO_PAGAMENTO
Exemplo 3: ID da Cobrança, ID do Caixa, ID do Tipo de Pagamento, Valor Pago e Data de Pagamento
PUT http://IP_RADIUSNET/radiusnet/index.php/api/v1/lc/12345/1/2?valorpago=59.90&dtpag=20250701
Exemplo 4: ID da Cobrança, ID do Caixa, ID do Tipo de Pagamento, Valor Pago, Data de Pagamento, Juros Pago e Multa Paga
PUT http://IP_RADIUSNET/radiusnet/index.php/api/v1/lc/12345/1/2?valorpago=59.90&dtpag=20250701&jurospago=2.50&multapaga=5.00
Observação:
Referente aos parâmetros opcionais, é possível informar somente Valor Pago e Data de Pagamento em casos que também seriam informados Juros Pago e Multa Paga. Para isso, inclua no Valor Pago os Juros Pago e Multa Paga.
Ou pode optar por informar Valor Pago, Data de Pagamento, Juros Pago e Multa Paga, sendo que o Valor Pago seria o valor sem Juros e Multa.
Parâmetros
| Parâmetro | Tipo | Obrigátório | Descrição |
|---|---|---|---|
| RTOKEN | Header Params | Sim | Chave de autorização para acesso a API. |
| ID_COBRANCA | Path Params | Sim | Código de identificação da cobrança que deseja realizar a liquidação. |
| ID_CAIXA | Path Params | Não | Código de identificação do caixa que deseja utilizar para realizar a liquidação. |
| ID_TIPO_PAGAMENTO | Path Params | Sim, se informado ID_CAIXA | Código de identificação do tipo pagamento que deseja utilizar para realizar a liquidação. |
| VALORPAGO | Query Params | Sim, se informado jurospago e/ou MULTAPAGA | Valor efetivamente pago pelo cliente (sem juros e multa). |
| DTPAG | Query Params | Sim, se informado VALORPAGO e/ou JUROSPAGO e/ou MULTAPAGA | Data em que o pagamento foi realizado (YYYYMMDD). |
| JUROSPAGO | Query Params | Não | Juros pago. |
| MULTAPAGA | Query Params | Não | Multa paga. |
8. (v1/cpl) Obter plano do cliente por Login.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/cpl/LOGIN" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [{ "id_cliente": "5561", "nome_razao": "NOME COMPLETO CLIENTE", "cpf_cnpj": "99999999999", "data_nascimento": "1954-02-28", "data_cadastro": "2018-06-14 00:00:00", "id_status_cliente": "1", "status_cliente": "Ativo", "id_tipo_pagamento_cliente": "1", "tipo_pagamento_cliente": "Boleto", "nome_boleto": "Boleto Itaú", "planos": [{ "id_cliente_plano": "5275", "id_end_instalacao": "5558", "endereco_instalacao": "Avenida Doutor João Amaral Gama, 824 - Jardim Caieira - Limeira\/SP CEP: 13483225", "id_end_cobranca": "5558", "endereco_cobranca": "Avenida Doutor João Amaral Gama, 824 - Jardim Caieira - Limeira\/SP CEP: 13483225", "plano": "15 MEGA-FIBRA", "id_status_plano": "2", "status_plano": "Ativo", "id_venc": "25", "dia_vencimento": "25", "valor_plano": "59.90", "valor_plano_ate_vencimento": null, "login": "usuario_pppoe", "senha": "123", "mac": "", "ddns": null, "wireless_psk": "", "nao_bloquear_ate": "2019-06-03", "data_ativacao": "2018-11-13 15:01:32", "isento": "0", "observacao": "", "franquia_ultrapassada": false, "dados_franquia_ultrapassada": null, "motivo_problema_regiao": { "id_motivo_problema_regiao": "1", "hora_retorno": "18", "minuto_retorno": "40" } }], "emails": [{ "email": "teste@teste.com.br" }], "telefones": [ { "ddd": "19", "telefone": "88888888" }, { "ddd": "19", "telefone": "99999999" } ] }], "count": 1 }
Este endpoint recupera o plano do cliente vinculado ao LOGIN(Nome de usuário do plano) informado como parâmetro desta API, o cliente/plano será retornado independente de seu status de ativação.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/cpl/LOGIN
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| LOGIN | Path | Sim | LOGIN(Nome de usuário do plano) do Cliente que deseja realizar a consulta de plano. |
9. (v1/tpc) Obter Caixa e Tipo de pagamento para liquidação da Cobrança.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/tpc/ID_COBRANCA" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": { "caixas": [ { "id_caixa": "1", "caixa": "Santander", "tipos_pagamento": [ { "id_tipo_pagamento": "2", "tipo_pagamento": "Boleto" }, { "id_tipo_pagamento": "4", "tipo_pagamento": "Depósito Dinheiro" }, { "id_tipo_pagamento": "5", "tipo_pagamento": "Transferência" }, { "id_tipo_pagamento": "10", "tipo_pagamento": "Depósito Cheque" } ] }, { "id_caixa": "2", "caixa": "Caixa Local (caixinha)", "tipos_pagamento": [ { "id_tipo_pagamento": "1", "tipo_pagamento": "Dinheiro" }, { "id_tipo_pagamento": "8", "tipo_pagamento": "Cheque" } ] } ] }, "count": 1 }
Para ter acesso a esta consulta será necessário atribuir a permissão no Radiusnet para "Consultar Tipo de Pagamento e Caixa via API". (Menu: Administração >> Configurações >> API).
Serão retornados apenas os Caixas e seus Tipos de pagamentos vinculados.
Caso o ID_COBRANCA informado no parâmetro desta API não esteja devidamente vinculada a um método de pagamento, os caixas e tipos de pagamentos não serão retornados nesta consulta.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/tpc/ID_COBRANCA
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| ID_COBRANCA | Path Params | Sim | Código de identificação da cobrança que deseja realizar a consulta de caixas e tipos de pagamento parametrizados no sistema. |
10. (v1/cpt) Obter planos do cliente por meio do telefone.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/cpt/DDDTELEFONE" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [{ "id_cliente": "5561", "nome_razao": "NOME COMPLETO CLIENTE", "cpf_cnpj": "99999999999", "data_nascimento": "1954-02-28", "data_cadastro": "2018-06-14 00:00:00", "id_status_cliente": "1", "status_cliente": "Ativo", "id_tipo_pagamento_cliente": "1", "tipo_pagamento_cliente": "Boleto", "nome_boleto": "Boleto Itaú", "planos": [{ "id_cliente_plano": "5275", "id_end_instalacao": "5558", "endereco_instalacao": "Avenida Doutor João Amaral Gama, 824 - Jardim Caieira - Limeira\/SP CEP: 13483225", "id_end_cobranca": "5558", "endereco_cobranca": "Avenida Doutor João Amaral Gama, 824 - Jardim Caieira - Limeira\/SP CEP: 13483225", "plano": "15 MEGA-FIBRA", "id_status_plano": "2", "status_plano": "Ativo", "id_venc": "25", "dia_vencimento": "25", "valor_plano": "59.90", "valor_plano_ate_vencimento": null, "login": "usuario_pppoe", "senha": "123", "mac": "", "ddns": null, "wireless_psk": "", "nao_bloquear_ate": "2019-06-03", "data_ativacao": "2018-11-13 15:01:32", "isento": "0", "observacao": "", "franquia_ultrapassada": false, "dados_franquia_ultrapassada": null, "motivo_problema_regiao": { "id_motivo_problema_regiao": "1", "hora_retorno": "18", "minuto_retorno": "40" } }], "emails": [ { "email": "cliente@email.com.br" }, { "email": "cliente@email2.com.br" } ], "telefones": [ { "ddd": "19", "telefone": "88888888" }, { "ddd": "19", "telefone": "99999999" } ] }], "count": 1 }
Este endpoint recupera todos os planos dos clientes vinculados ao telefone informado como parâmetro da API.
Os clientes/planos serão retornados independente de seu status de ativação.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/cpt/DDDTELEFONE
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| DDDTELEFONE | Path | Sim | O DDD e o telefone(somente números) do Cliente que deseja realizar a consulta de planos. |
11. (v1/ct) Adicionar telefone ao cliente.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/ct/" -H "RTOKEN: CHAVE_API" -F "IDCLI=CODIGO_CLIENTE" -F "DDD=DDD_DO_TELEFONE" -F "TEL=NUMERO_TELEFONE" -F "TT=TIPO_DO_TELEFONE" -F "IDOP=CODIGO_OPERADORA"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [ { "success": true, "cliente": { "id_cliente": "5561", "nome_razao": "NOME COMPLETO CLIENTE" }, "tipo_telefone": "TIPO TELEFONE", "operadora": "NOME OPERADORA", "ddd": "99", "telefone": "(99)9999999999", "observacao_telefone": "OBSERVACAO DO TELEFONE CADASTRADO" } ], "count": 1 }
No comando do curl certifique-se de substituir: • CODIGO_CLIENTE pelo código do cliente que será adicionado o telefone. • DDD_DO_TELEFONE pelo código regional referente ao número do telefone. • NUMERO_TELEFONE pelo número do telefone. • TIPO_DO_TELEFONE pelo código do tipo de telefone. • CODIGO_OPERADORA pelo código da operadora.
Este endpoint realiza o cadastro de telefone para clientes.
Se o tipo do telefone não for informado, o telefone por padrão será do tipo Residencial.
Se o código da operadora não for informado, a operadora por padrão será do tipo "Outras".
| Códigos para definir o tipo do telefone | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Códigos para definir a operadora
|
|
|
Method
POST
Solicitação HTTP
POST http://IP_RADIUSNET/radiusnet/index.php/api/v1/ct/
Parâmetros
** Todos os parâmetros Body Params desse endpoint é do tipo FORM DATA .
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| IDCLI | Body Params | Sim | O código do cliente(somente números) referente ao cadastro do telefone. |
| DDD | Body Params | Sim | O DDD do telefone(somente números). |
| TEL | Body Params | Sim | O número do telefone(somente números). |
| TT | Body Params | Não | O tipo do telefone(somente números). |
| IDOP | Body Params | Não | O código da operadora(somente números). |
12. (v1/astel) Alterar status do telefone.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/astel/" -H "RTOKEN: CHAVE_API" -F "IDCLI=CODIGO_CLIENTE" -F "DDD=DDD_DO_TELEFONE" -F "TELEFONE=TELEFONE" -F "IDSTATUS=CODIGO_NOVO_STATUS"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [ { "success": true, "msg": "Operation successful.", "id_cliente": 999, "ddd": "99", "telefone": "999999999", "status_anterior": "ativo", "status_atual": "inativo" } ], "count": 1 }
No comando do curl certifique-se de substituir: • CODIGO_CLIENTE pelo código do cliente que será adicionado o telefone. • DDD_DO_TELEFONE pelo código regional referente ao número do telefone. • NUMERO_TELEFONE pelo número do telefone. • CODIGO_STATUS pelo código do status.
Este endpoint ativa e desativa o telefone.
| Códigos para definir o status do telefone | ||||
|---|---|---|---|---|
|
Method
PUT
Solicitação HTTP
PUT http://IP_RADIUSNET/radiusnet/index.php/api/v1/astel/
Parâmetros
** Todos os parâmetros Body Params desse endpoint é do tipo URLENCODED .
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| IDCLI | Body Params | Sim | O código do cliente(somente números) referente ao cadastro do telefone. |
| DDD | Body Params | Sim | O DDD do telefone(somente números). |
| TELEFONE | Body Params | Sim | O número do telefone(somente números). |
| IDSTATUS | Body Params | Sim | O status do telefone(somente números). |
13. (v1/ascli) Alteração de status do cliente.
curl "http://localhost/radiusnet/index.php/api/v1/ascli/" -X PUT -H "RTOKEN: CHAVE_API" --data-urlencode "IDCLI=CODIGO_CLIENTE" --data-urlencode "IDSTATUS=CODIGO_NOVO_STATUS"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [ { "success": true, "msg": "Operation successful.", "id_cliente": "28", "nome_razao": "NOME COMPLETO CLIENTE", "status_anterior": "Bloqueado", "status_atual": "Arquivado" } ], "count": 1 }
No comando do curl certifique-se de substituir: • CODIGO_CLIENTE pelo código do cliente que será alterado o status. • CODIGO_NOVO_STATUS pelo código do novo status da alteração.
Este endpoint altera o status do cliente.
| Códigos para definir o status do cliente | ||||||
|---|---|---|---|---|---|---|
|
Method
PUT
Solicitação HTTP
PUT http://IP_RADIUSNET/radiusnet/index.php/api/v1/ascli/
Parâmetros
** Todos os parâmetros Body Params desse endpoint é do tipo URL-ENCODED .
| Parâmetro | Tipo | Obrigátório | Descrição |
|---|---|---|---|
| RTOKEN | Header Params | Sim | Chave de autorização para acesso a API. |
| IDCLI | Body Params | Sim | O código do cliente(somente números) referente a mudança de status. |
| IDSTATUS | Body Params | Sim | O código do novo status(somente números) que será atribuído ao cliente. |
14. (v1/st) Obter setores.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/st/" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [ { "id_setor": "1", "setor": "Padrão" }, { "id_setor": "2", "setor": "Central do Assinante" }, { "id_setor": "3", "setor": "Tecnico" } ], "count": 3 }
Este endpoint recupera todos os setores ativos.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/st/
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
15. (v1/svc) Obter serviços por meio do setor.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/svc/ID_SETOR" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [ { "id_servico": "7", "servico": "Mudança de Equipamento Zona Rural" }, { "id_servico": "10", "servico": "Manutenção Rede" }, { "id_servico": "20", "servico": "Instalação Fibra Óptica" }, { "id_servico": "23", "servico": "Retirada de Equipamento" }, { "id_servico": "30", "servico": "Manutenção Fibra Óptica" } ], "count": 4 }
Este endpoint recupera todos os serviços ativos relacionado ao código do setor.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/svc/ID_SETOR
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| ID_SETOR | Path | Sim | O código do setor(somente números) a ser utilizado na busca dos serviços. |
16. (v1/atr) Obter resoluções de atendimento.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/atr/" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [ { "id_resolucao_atendimento": "1", "resolucao_atendimento": "Encerrado com sucesso" }, { "id_resolucao_atendimento": "2", "resolucao_atendimento": "N/A" }, { "id_resolucao_atendimento": "3", "resolucao_atendimento": "Encerrado por falta de comunicação" } ], "count": 3 }
Este endpoint recupera todas as resoluções de atendimento ativos.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/atr/
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
17. (v1/atl) Obter atendimentos por meio do cliente.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/atl/ID_CLIENTE" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [ { "id_atendimento": "50", "protocolo": "9999999999999999", "responsavel_ultima_ocorrencia": "Responsável da Ocorrência", "setor": "Tecnico", "servico": "Troca de equipamento", "situacao": "Em Aberto", "data_abertura": "2020-06-01 14:00:50", "ultima_descricao": "Descrição da última ocorrência desse atendimento." }, { "id_atendimento": "65", "protocolo": "9999999999999999", "responsavel_ultima_ocorrencia": "Responsável da Ocorrência", "setor": "Tecnico", "servico": "Instalação", "situacao": "Resolvido", "data_abertura": "2020-06-01 14:00:00", "ultima_descricao": "Descrição da última ocorrência desse atendimento." } ], "count": 2 }
Este endpoint recupera todos os atendimentos abertos/resolvidos por cliente.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/atl/ID_CLIENTE
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| ID_CLIENTE | Path | Sim | Código do cliente(somente números) que será usado para listar os atendimentos. |
18. (v1/at) Criação de novo atendimento.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/at/" -H "RTOKEN: CHAVE_API" -F "IDCP=CODIGO_CLIENTE_PLANO" -F "IDST=CODIGO_SETOR" -F "IDSVC=CODIGO_SERVICO" -F "DESC=DESCRICAO" -F "IDFUNC=CODIGO_FUNCIONARIO" -F "TP=TEMPO_ATENDIMENTO"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [ { "success": true, "id_atendimento": "8", "protocolo": "9999999999999999", "cliente": { "id_cliente": "47", "nome_razao": "NOME COMPLETO CLIENTE", "cpf_cnpj": "99999999999", "plano": { "id_cliente_plano": "20", "plano": "Cabo - 2 Megas" } }, "funcionario_ultimo_atendimento": "RESPONSAVEL PELO ATENDIMENTO", "setor": "Tecnico", "servico": "Instalação", "situacao": "Em Aberto", "data_abertura": "24/02/2020 11:32:11", "descricao": "Descrição do atendimento", "tempo_atendimento": "00:20:00", "empresa": "NOME DO PROVEDOR" } ], "count": 1 }
No comando do curl certifique-se de substituir: • CODIGO_CLIENTE_PLANO pelo código do cliente plano que será vinculado ao atendimento. • CODIGO_SETOR pelo código do setor existente no sistema. • CODIGO_SERVICO pelo código do serviço existente no sistema. • DESCRICAO pela descrição que será registrada na ocorrência do atendimento. • CODIGO_FUNCIONARIO pelo código do funcionário responsável pelo atendimento. • TEMPO_ATENDIMENTO pela quantidade de tempo que o atendimento terá.
Este endpoint inicia um novo atendimento para clientes plano.
Somente é possível criar atendimentos com o status "Em Aberto".
Se o código de funcionário não for informado, o responsável pelo chamado será a API.
Se o tempo de atendimento não for informado, o tempo de atendimento será zero.
Nota Importante: Este endpoint agora inclui uma validação que impede a abertura de múltiplos atendimentos para o mesmo setor e serviço se já houver um atendimento em aberto. Isso garante que não haja duplicidade de atendimentos para o mesmo assunto, melhorando a organização e o gerenciamento dos atendimentos.
Method
POST
Solicitação HTTP
POST http://IP_RADIUSNET/radiusnet/index.php/api/v1/at/
Parâmetros
** Todos os parâmetros Body Params desse endpoint é do tipo FORM DATA .
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| IDCP | Body Params | Sim | Código do cliente plano(somente números) referente ao novo atendimento. |
| IDST | Body Params | Sim | Código do setor(somente números) referente ao novo atendimento. |
| IDSVC | Body Params | Sim | Código do serviço(somente números) referente ao novo atendimento. |
| DESC | Body Params | Sim | Descrição referente ao novo atendimento. |
| IDFUNC | Body Params | Não | Código do funcionário(somente números) referente ao novo atendimento. |
| TP | Body Params | Não | Tempo de atendimento(somente números). Informar esse parâmetro em segundos. |
19. (v1/atno) Adicionar ocorrência de atendimento.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/atno/" -H "RTOKEN: CHAVE_API" -F "IDAT=CODIGO_ATENDIMENTO" -F "DESC=DESCRICAO_ATENDIMENTO" -F "DESCR=DESCRICAO_RESOLUCAO_ATENDIMENTO"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [ { "success": true, "id_atendimento": "8", "protocolo": "9999999999999999", "id_cliente": "47", "nome_razao": "NOME COMPLETO CLIENTE", "cpf_cnpj": "99999999999", "id_cliente_plano": "20", "plano": "Cabo - 2 Megas", "funcionario_ultimo_atendimento": "RESPONSAVEL PELO ATENDIMENTO", "setor": "Tecnico", "servico": "Instalação", "situacao": "Em Aberto", "data_abertura": "24/02/2020 11:32:11", "descricao": "Descrição do atendimento", "tempo_atendimento": "00:20:00" } ], "count": 1 }
No comando do curl certifique-se de substituir: • CODIGO_ATENDIMENTO pelo código de atendimento já existente. • DESCRICAO_ATENDIMENTO com a informação da nova ocorrência.
Este endpoint adiciona novas ocorrências para atendimentos em aberto.
Method
POST
Solicitação HTTP
POST http://IP_RADIUSNET/radiusnet/index.php/api/v1/atno/
Parâmetros
** Todos os parâmetros Body Params desse endpoint é do tipo FORM DATA.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| IDAT | Body Params | Sim | Código do atendimento(somente números) referente ao atendimento que será incluído a nova ocorrência. |
| DESC | Body Params | Sim | A descrição referente a nova ocorrência. |
20. (v1/atf) Finalizar atendimento.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/atf/" -H "RTOKEN: CHAVE_API" -F "IDAT=CODIGO_ATENDIMENTO" -F "IDR=CODIGO_RESOLUCAO_ATENDIMENTO" -F "DESC=DESCRICAO_ATENDIMENTO"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [ { "success": true, "id_atendimento": "8", "protocolo": "9999999999999999", "cliente":{ "id_cliente": "47", "nome_razao": "NOME COMPLETO CLIENTE", "cpf_cnpj": "99999999999", "plano":{ "id_cliente_plano": "20", "plano": "Cabo - 2 Megas" } }, "funcionario_ultimo_atendimento": "RESPONSAVEL PELO ATENDIMENTO", "setor": "Tecnico", "servico": "Instalação", "situacao": "Resolvido", "data_abertura": "24/02/2020 11:32:11", "descricao": "Descrição do atendimento", "tempo_atendimento": "00:20:00" } ], "count": 1 }
No comando do curl certifique-se de substituir: • CODIGO_ATENDIMENTO pelo código de atendimento já existente. • CODIGO_RESOLUCAO_ATENDIMENTO pelo código da resolução de atendimento. • DESCRICAO_ATENDIMENTO com a informação da nova ocorrência. • DESCRICAO_RESOLUCAO_ATENDIMENTO com a descrição da resolução.
Este endpoint finaliza atendimentos ainda em aberto.
Method
POST
Solicitação HTTP
POST http://IP_RADIUSNET/radiusnet/index.php/api/v1/atf/
Parâmetros
** Todos os parâmetros Body Params desse endpoint é do tipo FORM DATA.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| IDAT | Body Params | Sim | Código do atendimento(somente números) referente ao atendimento que será incluído a nova ocorrência. |
| IDR | Body Params | Sim | Código de resolução do atendimento(somente números) para definir o tipo de resolução que o atendimento terá. |
| DESC | Body Params | Sim | A descrição referente a nova ocorrência. |
| DESCR | Body Params | Sim | A descrição da resolução do atendimento. |
21. (v1/nf) Retorna as Notas Fiscais por cliente
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/nf/FILTRO1/IDCLIENTE_CPF_CNPJ/FILTRO2" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [ { "id_cliente": "1502", "nome_razao": "Cliente 1", "notas_fiscais": [ { "codigo_nf": "5687", "id_cobranca": "1006003", "numero_nf": "180111", "tipo": "NF 21", "valor_cobranca": "R$ 89,90", "valor_icms": "R$ 0,00", "data_emissao": "01/01/2018", "data_servico": "01/01/2018" }, { "codigo_nfse": "4500", "id_cobranca": "1506003", "numero_rps": "7510", "tipo": "NFSE", "valor_cobranca": "R$ 81,90", "data_emissao": "01/01/2018" }, { "codigo_nd": "7", "id_cobranca": "1837019", "numero_nd": "73620", "tipo": "Nota de Débito", "valor_cobranca": "109.89", "data_emissao": "01/01/2018", "periodo_prestacao": "01/2018" } ] }, { "id_cliente": "1506", "nome_razao": "Cliente 2", "notas_fiscais": [ { "codigo_nf": "1", "id_cobranca": "3300007", "numero_nf": "120000", "tipo": "NF 21", "valor_cobranca": "R$ 150,00", "valor_icms": "R$ 0,00", "data_emissao": "01/01/2018", "data_servico": "01/01/2018" } ] } ], "count": 2 }
Este endpoint lista todas as Notas Fiscais pertencentes ao cliente.
Para utilização, deverá ser informado o valor do FILTRO1, para que seja possível saber se será usado o código do cliente ou CPF/CNPJ para informar o cliente, na busca das Notas Fiscais.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/nf/FILTRO1/IDCLIENTE_CPF_CNPJ/FILTRO2
Parâmetros
| Parâmetro | Tipo | Obrigátório | Descrição |
|---|---|---|---|
| RTOKEN | Header Params | Sim | Chave de autorização para acesso a API. |
| FILTRO1 | Path Params | Sim | Identifica qual será o valor que será usado para buscar o cliente, se será pelo Código Cliente ou se será por CPF/CNPJ |
| IDCLIENTE_CPF_CNPJ | Path Params | Sim | O Código Cliente ou CPF/CNPJ do cliente (Depende exclusivamente do FILTRO1) |
| FILTRO2 | Path Params | Não | No FILTRO2 é possível informar se deve ser retornado apenas Notas Fiscais 21/22, Notas Fiscais de Serviço Eletrônica, Notas de Débito ou Nota Fiscal Eletrônica (Sefaz). |
| Filtros Disponíveis (FILTRO1) | Descrição |
|---|---|
| idcli | Código do cliente |
| cpfcnpjcli | CPF/CNPJ do cliente |
| Filtros Disponíveis (FILTRO2) | Descrição |
|---|---|
| nfs | Retorna apenas Notas Fiscais de Serviços do cliente. |
| nfse | Retorna apenas Notas Fiscais de Serviços Eletrônica do cliente. |
| nfd | Retorna apenas Notas de Débito do cliente. |
| nfe | Retorna apenas Notas Fiscal Eletrônica (Sefaz) do cliente. |
22. (v1/pdfnf) Obter PDF da Nota Fiscal 21/22
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/pdfnf/ID_NF" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": "http://IP_RADIUSNET/other/downloads/notasFiscais/500aac51/NF_0001_122020_NOMECLIENTE.pdf", "count": 1 }
Este endpoint recupera o PDF da Nota Fiscal.
Deverá ser informado o código da Nota Fiscal para que seja retornado um link para o PDF.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/pdfnf/ID_NF
Parâmetros
| Parâmetro | Tipo | Obrigátório | Descrição |
|---|---|---|---|
| RTOKEN | Header Params | Sim | Chave de autorização para acesso a API. |
| ID_NF | Path Params | Sim | Código de identificação da nota fiscal para ser gerado o PDF. |
23. (v1/pdfnfse) Obter PDF da Nota Fiscal Eletrônica
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/pdfnfse/ID_NFSE" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": "http://IP_RADIUSNET/other/downloads/notasFiscais/500aac51/NFSE_NOMECLIENTE_01012020.pdf", "count": 1 }
Este endpoint recupera o PDF da Nota Fiscal Eletrônica.
Deverá ser informado o código da Nota Fiscal Eletrônica para que seja retornado um link para o PDF.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/pdfnfse/ID_NFSE
Parâmetros
| Parâmetro | Tipo | Obrigátório | Descrição |
|---|---|---|---|
| RTOKEN | Header Params | Sim | Chave de autorização para acesso a API. |
| ID_NFSE | Path Params | Sim | Código de identificação da Nota Fiscal Eletrônica para ser gerado o PDF. |
24. (v1/pdfnfd) Obter PDF da Nota de Débito
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/pdfnfd/ID_ND" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": "http://IP_RADIUSNET/other/downloads/notasDebito/500aac51/ND_NOMECLIENTE_01012020.pdf", "count": 1 }
Este endpoint recupera o PDF da Nota de Débito.
Deverá ser informado o código da Nota de Débito para que seja retornado um link para o PDF.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/pdfnfd/ID_ND
Parâmetros
| Parâmetro | Tipo | Obrigátório | Descrição |
|---|---|---|---|
| RTOKEN | Header Params | Sim | Chave de autorização para acesso a API. |
| ID_ND | Path Params | Sim | Código de identificação da Nota de Débito para ser gerado o PDF. |
25. (v1/pdfnfe) Obter PDF da Nota Fiscal Eletrônica (Sefaz)
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/pdfnfe/ID_NFE" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": "http://IP_RADIUSNET/other/downloads/notaFiscaisNfe/HASHNOTAFISCALNFE/danfe_HASHNOTAFISCALNFE.pdf"", "count": 1 }
Este endpoint recupera o PDF da Nota Fiscal Eletronica (Sefaz).
Deverá ser informado o código da Nota Fiscal Eletronica (Sefaz) para que seja retornado um link para o PDF.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/pdfnfe/ID_NFE
Parâmetros
| Parâmetro | Tipo | Obrigátório | Descrição |
|---|---|---|---|
| RTOKEN | Header Params | Sim | Chave de autorização para acesso a API. |
| ID_NFE | Path Params | Sim | Código de identificação da Nota Fiscal Eletronica (Sefaz) para ser gerado o PDF. |
26. (v1/ftp) Obter PDF da fatura
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/asemail/ID_COBRANCA" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": "http://IP_RADIUSNET/other/downloads/faturas/500aac51/FATURAS_01012020.pdf", "count": 1 }
Este endpoint recupera o PDF da Fatura de uma Cobrança.
Deverá ser informado o código da Cobrança para que seja retornado um link para o PDF.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/ftp/ID_COBRANCA
Parâmetros
| Parâmetro | Tipo | Obrigátório | Descrição |
|---|---|---|---|
| RTOKEN | Header Params | Sim | Chave de autorização para acesso a API. |
| ID_COBRANCA | Path Params | Sim | Código de identificação da Cobrança para ser gerado o PDF. |
27. (v1/cemail) Obter e-mails de um cliente.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/cemail/ID_CLIENTE" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": { "id_cliente": "99999", "nome_razao": "NOME DO CLIENTE", "emails": [ { "id_email": "1", "email": "email1@teste.com" }, { "id_email": "2", "email": "email2@teste.com" }, { "id_email": "3", "email": "email2@teste.com" } ], "qtd_emails": 3 }, "count": 4 }
Este endpoint recupera todos os emails ativos de um cliente.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/cemail/ID_CLIENTE
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| ID_CLIENTE | Path | Sim | Código do cliente para buscar os emails. |
28. (v1/altemail) Alterar o e-mail de um cliente.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/altemail/" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [{ "success": true, "msg": "E-mail alterado com sucesso.", "cliente": { "id_cliente": "99999", "nome_razao": "NOME CLIENTE" }, "id_email": 1, "email_anterior": "email_a@teste.com", "email_posterior": "email_b@teste.com" }], "count": 1 }
Este endpoint altera um email existente para um cliente cadastrado no sistema.
Method
PUT
Solicitação HTTP
PUT http://IP_RADIUSNET/radiusnet/index.php/api/v1/altemail/
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| IDEMAIL | Body Params | Sim | O código do email ao qual será feito a alteração. |
| Body Params | Sim | O novo e-mail que irá sobrescrever o email já existente. |
29. (v1/adicemail) Adicionar um e-mail ao cliente.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/adicemail/" -H "RTOKEN: CHAVE_API" -F "IDCLI=CODIGO_CLIENTE" -F "EMAIL=NOVO_EMAIL"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [ { "success": true, "msg": "E-mail criado com sucesso.", "cliente": { "id_cliente": "99", "nome_razao": "CLIENTE TESTE" }, "id_email": "10", "email": "teste@teste.com" } ], "count": 1 }
No comando do curl certifique-se de substituir: • IDCLI pelo código do cliente já existente. • EMAIL pelo novo email que deseje cadastrar.
Este endpoint cadastra novos emails para clientes já existentes no sistema.
Method
POST
Solicitação HTTP
POST http://IP_RADIUSNET/radiusnet/index.php/api/v1/adicemail/
Parâmetros
** Todos os parâmetros Body Params desse endpoint é do tipo FORM DATA.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| IDCLI | Body Params | Sim | Código do cliente referente ao novo email. |
| Body Params | Sim | O email que deseja cadastrar. |
30. (v1/asemail) Alterar status do E-mail.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/asemail/" -H "RTOKEN: CHAVE_API" -F "IDCLI=CODIGO_CLIENTE" -F "EMAIL=EMAIL" -F "IDSTATUS=CODIGO_NOVO_STATUS"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [ { "success": true, "msg": "Operation successful.", "id_cliente": 99999, "email": "teste@teste.com.br", "status_anterior": "inativo", "status_atual": "ativo" } ], "count": 1 }
No comando do curl certifique-se de substituir: • CODIGO_CLIENTE pelo código do cliente que será adicionado o e-mail. • EMAIL pelo e-mail. • CODIGO_STATUS pelo código do status.
Este endpoint ativa e desativa o e-mail.
| Códigos para definir o status do e-mail | ||||
|---|---|---|---|---|
|
Method
PUT
Solicitação HTTP
PUT http://IP_RADIUSNET/radiusnet/index.php/api/v1/asemail/
Parâmetros
** Todos os parâmetros Body Params desse endpoint é do tipo FORM DATA .
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| IDCLI | Body Params | Sim | O código do cliente(somente números) referente ao cadastro do e-mail. |
| Body Params | Sim | O e-mail. | |
| IDSTATUS | Body Params | Sim | O status do e-mail(somente números). |
31. (v1/lp) Obter logins por Plano.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/lp/CODIGO_PLANO" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [{ "login": "username1", "id_status_plano": "2", "status_plano": "Ativo" }, { "login": "username2", "id_status_plano": "2", "status_plano": "Ativo" }], "count": 2 }
Este endpoint recupera todos os logins vinculados ao código de plano informado como parâmetro desta API.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/lp/CODIGO_PLANO
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| CODIGO_PLANO | Path | Sim | Código do plano que deseja obter os logins. |
32. (v1/scp) Obter Status Cobrança/Pix.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/scp/ID_COBRANCA" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
// Cobrança Pendente { "rows": { "qrcode_copy_paste": "xxxPIXCopiaColaxxxx", "qrcode_base64": "data:image/svg+xml;base64,XXXX", //Retorno IMG em base64 "isVencido": false, // false - Cobrança Não Vencida // true - Cobrança Vencida "id_cobranca": "ID_COBRANCA", // Código Cobrança "pago": "0", // 0 - Não Pago // 1 - Pago "valor_pago": null }, "count": 6 } // Cobrança Paga { "rows": { "isVencido": false, // "id_cobranca": "ID_COBRANCA", //Código Cobrança "pago": "1", "valor_pago": "0,00" // Valor Cobrança Paga }, "count": 4 }
Este endpoint tem como finalidade colocar como prioridade a cobrança consultada através da integrações bancárias, que disponibilizam Pix Copia e Cola/QR Code.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/scp/ID_COBRANCA
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| ID_COBRANCA | Path | Sim | Código de identificação da Cobrança. |
33. (v1/getindcli) Lista Indicação Lead
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/getindcli/CPF_CLIENTE" -H "CRMTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [ { "id_lead_indicacao": "1", "id_lead": "2", "id_lead_indicacao_config": "", "id_meio_de_entrada": "4", "nome_indicado": "Teste", "email_indicado": "jpsantana@radius.net.br", "ddd_indicado": "19", "telefone_indicado": "", "cpf_quem_indica": "", "ddd_quem_indica": "", "telefone_quem_indica": "", "tipo_indicacao": "cliente", "id_cliente_indica": "", "id_funcionario_indica": "", "converteu_lead": "1", // 2 => 'Aguardando', 1 => 'Efetivado', 0 => 'Não efetivado'; "id_funcionario_insert": "", "data_hora_indicacao": "", "dados_existentes": "", "origem": "Sistema", "telefone_quem_indica_formated": "", "telefone_indicado_formated": "", "cpf_quem_indica_formated": "" } ], "count": 1 }
Este endpoint retorna todos os dados preenchidos dos clientes indicados do CPF informado.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/getindcli/CPF_CLIENTE
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| CRMTOKEN | Header | Sim | Chave de autorização para acesso a API LEAD. |
| CPF_CLIENTE | Path | Sí | Documento CPF cliente |
34. (v1/cbpi/) Obter cobranças dos clientes/plano pelo identificador.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/cbpi/FILTRO/IDENTIFICADOR" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
============== /v1/cbpi/np/ ============== { "rows": [{ "itensPlano": [{ "id_cobranca_plano": "80427", "valor": "114.90", "acrescimo": null, "desconto": null, "juros": "1.00", "multa": "2.00", "valor_pago": null, "valor_ate_vencimento": null, "plano": "10 MEGA PERMUTA - FIBRA OPTICA", "juros_pagar": 0, "multa_pagar": 0, "valor_atualizado": "114.90" },{ "id_cobranca_plano": "80451", "valor": "199.90", "acrescimo": null, "desconto": null, "juros": "1.00", "multa": "2.00", "valor_pago": null, "valor_ate_vencimento": null, "plano": "30 MEGA SIMETRICO PERMUTA - FIBRA OPTICA", "juros_pagar": 0, "multa_pagar": 0, "valor_atualizado": "199.90" }], "itensAvulsa": [], "valor_pago_cobranca": "0.00", "id_cliente_plano": "447", "pago": "0", "id_cobranca": "7387143", "periodo_prestacao": "12/2019", "data_vencimento": "2020-01-10", "desconto_ate_vencimento": "20.00", "data_vencimento_util": "2020-01-10", "valor_total_a_pagar": "294.80", "valor_total_cobranca": 314.80, "isGerenciaNet": "1", "isBoletoFacil": "0", "nosso_numero": null, "linha_digitavel": "99999.99999 99999.999999 99999.999999 3 81300000031480", "isVencido": false }], "count": 4 } ============== /v1/cbpi/at/ ============== { "rows": [{ "itensPlano": [{ "id_cobranca_plano": "80413", "valor": "114.90", "acrescimo": null, "desconto": null, "juros": "1.00", "multa": "2.00", "valor_pago": null, "valor_ate_vencimento": null, "plano": "10 MEGA PERMUTA - FIBRA OPTICA", "juros_pagar": "0.15", "multa_pagar": "2.30", "valor_atualizado": "117.35" }, { "id_cobranca_plano": "80437", "valor": "199.90", "acrescimo": null, "desconto": null, "juros": "1.00", "multa": "2.00", "valor_pago": null, "valor_ate_vencimento": null, "plano": "30 MEGA SIMETRICO PERMUTA - FIBRA OPTICA", "juros_pagar": "0.27", "multa_pagar": "4.00", "valor_atualizado": "204.17" }], "itensAvulsa": [], "valor_pago_cobranca": "0.00", "id_cliente_plano": "447", "pago": "0", "id_cobranca": "7387129", "periodo_prestacao": "05/2019", "data_vencimento": "2019-06-06", "desconto_ate_vencimento": "20.00", "data_vencimento_util": "2019-06-06", "valor_total_a_pagar": "301.52", "valor_total_cobranca": 321.52, "isGerenciaNet": "1", "isBoletoFacil": "0", "nosso_numero": null, "linha_digitavel": "99999.99999 99999.999999 99999.999999 1 79920000043887", "isVencido": true, "promessa_pagamento": true }], "count": 1 } ============== /v1/cbpi/pg/ ============== { "rows": [{ "itensPlano": [{ "id_cobranca_plano": "6597", "valor": "99.90", "acrescimo": null, "desconto": null, "juros": "1.00", "multa": "2.00", "valor_pago": "99.90", "valor_ate_vencimento": null, "plano": "10 MEGA PERMUTA - FIBRA OPTICA" }], "itensAvulsa": [], "valor_pago_cobranca": "79.90", "id_cliente_plano": "447", "pago": "1", "id_cobranca": "7308112", "periodo_prestacao": "03/2016", "data_vencimento": "2016-04-10", "desconto_ate_vencimento": "20.00", "data_vencimento_util": "2016-04-11", "valor_total_a_pagar": "79.90", "valor_total_cobranca": 99.90, "isGerenciaNet": "0", "isBoletoFacil": "0", "nosso_numero": "7308112", "data_pagamento": "2016-04-05" }], "count": 1 }
Este endpoint recupera as cobranças dos clientes/plano de acordo com o identificador.
Serão retornadas as cobranças dos clientes/plano conforme as seguintes situações em que elas se encontram:
Cobranças dos clientes/plano não pagas: serão retornadas apenas as cobranças disponíveis para pagamento, ou seja, essas devem estar devidamente vinculadas a um método de pagamento, Boleto com Registro, Gerencianet, Boleto Fácil, Cobrança Interna, etc.
Caso o
IDENTIFICADORinformado no parâmetro desta API possua cobranças, mas estas não estejam devidamente vinculadas a um método de pagamento, elas não serão retornadas nesta consulta.Cobranças dos clientes/plano pagas: serão retornadas todas as cobranças pagas de planos pertencentes ao
IDENTIFICADORinformado no parâmetro desta API.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/cbpi/FILTRO/IDENTIFICADOR
Parâmetros
| Parâmetro | Tipo | Obrigátório | Descrição |
|---|---|---|---|
| RTOKEN | Header Params | Sim | Chave de autorização para acesso a API. |
| FILTRO | Path Params | Sim | Identificação do Filtro de listagem das cobranças(tabela abaixo). |
| IDENTIFICADOR | Path Params | Sim | Código de identificação do cliente/plano que deseja realizar a consulta de cobranças. |
| Filtros Disponíveis | Descrição |
|---|---|
| np | Cobranças dos clientes/plano não pagas - todas as cobranças não pagas. |
| at | Cobranças dos clientes/plano não pagas - apenas as cobranças em atraso. |
| pg | Cobranças dos clientes/plano pagas - todas as cobranças pagas. |
35. (v1/cl) Obter Dados Conexão Clientes
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/cl?pagina=NUMERO_PAGINA&status=CODIGO_STATUS_CLIENTE&limite=LIMITE_REGISTROS_POR_PAGINA" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [ { "cliente": { "id_cliente": "1", "nome_cliente": "Jose da Silva Teste", "status_cliente": "Arquivado" }, "clientePlano": { "id_cliente_plano": "1", "loginPPOE": "jose.silva.teste", "senha": "12345", "mac": "", "ip": null }, "clienteEndereco": { "id_endereco": "4", "cidade": "São Paulo", "estado": "São Paulo", "UF": "SP", "bairro": "Bela Vista", "logradouro": "Avenida Paulista - de 612 a 1510 - lado par", "numero": "999", "complemento": "", "cep": "01310100", "referencia": "", "observacao_end": "" }, "clienteTelefone": { "ddd": "99", "telefone": "99999999", "tipo_telefone": "Residencial" } } ], "count": 1 }
No comando do curl certifique-se de substituir: • NUMERO_PAGINA pelo número da página para paginação. Default é 1. • CODIGO_STATUS_CLIENTE pelo código do status do cliente. Default é 5 (todos os status). • LIMITE_REGISTROS_POR_PAGINA pelo número de registros por página. Default é 500.
Este endpoint recupera os dados de conexão dos clientes, incluindo nome, login PPPOE, senha, MAC, IP, endereço e telefone. É útil para integrações de relatórios de acompanhamento de rede fibra.
Tem um limite padrão de 500 registros por página, mas é possível definir um limite menor manualmente. O máximo permitido é 500 por página.
É possível escolher o número da página em que quer visualizar os dados.
Também é possível filtrar os dados pelo status do cliente.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/cl?pagina=NUMERO_PAGINA&status=CODIGO_STATUS_CLIENTE&limite=LIMITE_REGISTROS_POR_PAGINA
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| PAGINA | Query | Não | Número da página para paginação. Default é 1. |
| STATUS | Query | Não | Status do cliente. Default é 5 (todos os status). |
| LIMITE | Query | Não | Número de registros por página. Default é 500, limite máximo é 500. |
Códigos para definir o status do cliente
| Códigos para definir o status do cliente | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
36. (v1/cpi) Obter planos do cliente por Código Identificador.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/cpi/NUMERO_IDENTIFICADOR/ID_STATUS_PLANO" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [ { "id_cliente": "8", "nome_razao": "NOME COMPLETO CLIENTE", "cpf_cnpj": "99999999999", "rg": "", "data_nascimento": "1970-02-23", "data_cadastro": "2021-06-14 00:00:00", "id_status_cliente": "1", "identificador": "88888888888", "status_cliente": "Ativo", "id_tipo_pagamento_cliente": "1", "tipo_pagamento_cliente": "Boleto", "isBoletoFacil": "0", "isIugu": "0", "isGerenciaNet": "1", "nome_boleto": null, "senha_central_md5": null, "planos": [ { "id_cliente_plano": "8", "id_end_instalacao": "11", "endereco_instalacao": "RUA DA VICINAL P2 LADEIRAO, 0, PROXIMO O CAMPO GRANDE - CENTRO - Rorainópolis/RR CEP: 69373000", "id_end_cobranca": "11", "endereco_cobranca": "RUA DA VICINAL P2 LADEIRAO, 0, PROXIMO O CAMPO GRANDE - CENTRO - Rorainópolis/RR CEP: 69373000", "plano": "BANDA LARGA 100 MEGAS FIBRA OPTICA", "id_plano": "20", "grupo_plano": "Vila do Equador", "id_status_plano": "2", "status_plano": "Ativo", "id_venc": "10", "dia_vencimento": "10", "valor_plano": "180.00", "valor_plano_ate_vencimento": "0.00", "login": "usuario_pppoe", "senha": "123", "mac_cadastro": "", "ddns": null, "wireless_psk": "", "nao_bloquear_ate": "2023-02-25", "data_ativacao": "2021-04-09 14:21:59", "isento": "0", "observacao": "", "tipo_plano": "SCM Internet", "id_tipo_plano": "1", "regiao_com_problema": "Não", "franquia_ultrapassada": false, "info_franquia_ultrapassada": null } ], "emails": [], "telefones": [], "statusRoteador": { "status": "Offline", "Ip": "Offline" } } ], "count": 1 }
Este endpoint recupera todos os planos do cliente vinculados ao Código Identificador informado como parâmetro desta API, caso informe o parametro ID_STATUS_PLANO, serão retornados apenas os planos provenientes do ID_STATUS_PLANO informado, caso não informado, todos os planos serão retornados independente de seu status.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/cpi/NUMERO_IDENTIFICADOR/ID_STATUS_PLANO
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| NUMERO_IDENTIFICADOR | Path | Sim | Código identificador do Cliente que deseja realizar a consulta de planos. |
| ID_STATUS_PLANO | Path | Não | Código identificador de status dos planos(somente números 1 a 5, conforme tabela abaixo). |
| Valores para ID_STATUS_PLANO | Descrição |
|---|---|
| 1 | Pendente - Plano aguardando ativação. |
| 2 | Ativo - Plano já ativado. |
| 3 | Inativo - Plano inativo. |
| 4 | Pré-Ativo - Plano aguardando ativação (disponível apenas para ativação através da Central do Técnico - CDT). |
| 5 | Listar Todos os registros independente de seu status. |
| não informado | Por padrão, os registros com status "Inativo" não serão listados |
37. (v1/qrp) Obter instrução do qr code do pix e copia/cola.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/qrp/ID_COBRANCA" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": { "id_cobranca": "52194", "status_pago": 0, "pago": "Não", "qrcode_copy_paste": "xxxPIXCopiaColaxxxx", "qrcode_base64": "data:image/svg+xml;base64,XXXX" }, "count": 5 }
Este endpoint recupera a instrução do qr code do pix e copia/cola vinculada a cobrança informada como parâmetro desta API, com o id da cobrança.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/qrp/ID_COBRANCA
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| ID_COBRANCA | Path | Sim | Código identificador da cobrança que deseja realizar a consulta do qr code do pix e copia/cola. |
38. (v1/ucp) Obter Recibo da última cobrança paga pelo cliente.
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/ucp/ID_COBRANCA" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": { "http://IP_RADIUSNET/other/downloads/recibo/2000000vd/pdf/recibo_000000000000.pdf", }, "count": 1 }
Este endpoint gera o recibo de cobranças pagas informadas como parâmetro desta API, através do id da cobrança desejada.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/ucp/ID_COBRANCA
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| ID_COBRANCA | Path | Sim | Código identificador da cobrança que deseja gerar o recibo. |
39. (v1/termo) Obter Termo de Adesão ou Cancelamento (PDF ou ODT).
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/termo/ID_CLIENTE_PLANO/TIPO_TERMO/TIPO_DOWNLOAD" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
============== /v1/termo/ID_CLIENTE_PLANO/0/pdf ============== { "rows": "https://IP_RADIUSNET/other/downloads/termoAdesao/0000000/termoAdesao_00000.pdf", "count": 1 } ============== /v1/termo/ID_CLIENTE_PLANO/0/odt ============== { "rows": "https://IP_RADIUSNET../other/downloads/termoAdesao/termoAdesao_0000000.odt", "count": 1 } ============== /v1/termo/ID_CLIENTE_PLANO/1/pdf ============== { "rows": "https://IP_RADIUSNET/other/downloads/termoCancelamento/0000000/termoCancelamento_000000.pdf", "count": 1 } ============== /v1/termo/ID_CLIENTE_PLANO/1/odt ============== { "rows": "https://IP_RADIUSNET../other/downloads/termoCancelamento/termoCancelamento_00000.odt", "count": 1 }
Este endpoint retorna o link para download do Termo de Adesão ou Termo de Cancelamento, em PDF ou ODT.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/termo/ID_CLIENTE_PLANO/TIPO_TERMO/TIPO_DOWNLOAD
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| ID_CLIENTE_PLANO | Path | Sim | Código identificador do Cliente Plano que deseja retornar o Termo. |
| TIPO_TERMO | Path | Sim | Determina se é Termo de Adesão ou Termo de Cancelamento. |
| TIPO_DOWNLOAD | Path | Sim | Determina o formato desejado do arquivo, PDF ou ODT. |
| Valores para TIPO_TERMO | Descrição |
|---|---|
| 0 | Termo de Adesão. |
| 1 | Termo de Cancelamento. |
| Valores para TIPO_DOWNLOAD | Descrição |
|---|---|
| odt | ODT |
40. (v1/cbdt) Obter Cobranças por data
curl "http://IP_RADIUSNET/radiusnet/index.php/api/v1/cbdt?tipo_data=TIPO_DATA&data_inicio=DATA_INICIO&data_fim=DATA_FIM&em_aberto=EM_ABERTO&status_cliente=STATUS_CLIENTE&apenas_em_atraso=APENAS_EM_ATRASO&tipo_resultado=TIPO_RESULTADO&pagina=PAGINA&limite=LIMITE" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
============== /v1/cbdt? tipo_data=data_vencimento& data_inicio=2025-07-01& data_fim=2025-07-07& em_aberto=todos& status_cliente=5& apenas_em_atraso=todos& tipo_resultado=simplificado& pagina=1& limite=1 ============== { "rows": [ { "id_cobranca": "591000", "id_cliente_plano": "12345", "data_vencimento": "2025-07-05", "pago": "0", "data_pagamento": null, "valor_original": "99.90", "acrescimo": "0.00", "desconto": "0.00", "valor": "99.90", "valor_juros_pago": "0.00", "valor_multa_paga": "0.00", "valor_pago": "0.00", "codigo_barras": "00000.00000 00000.000000 00000.000000 0 00000000000000", "qrcode_copy_paste": "", "gerencianet_html_link": null, "url_pdf_fatura": "http://IP_RADIUSNET/radiusnet/index.php/api/v1/ftp/591000", "url_pdf_boleto": "http://IP_RADIUSNET/radiusnet/index.php/api/v1/bc/591000", "tipo_pagamento": "Boleto", "valor_juros_a_pagar": "0.00", "valor_multa_a_pagar": "0.00", "isVencido": false } ], "count": 1 }
CLIQUE AQUI
============== /v1/cbdt? tipo_data=data_vencimento& data_inicio=2025-07-01& data_fim=2025-07-07& em_aberto=todos& status_cliente=5& apenas_em_atraso=todos& tipo_resultado=detalhado& pagina=1& limite=1 ============== { "rows": [ { "id_cliente_plano": "12345", "pago": "0", "id_cobranca": "591000", "periodo_prestacao": "06/2025", "tipo_pagamento": "Boleto", "status_cliente": "Arquivado", "data_vencimento": "2025-07-05", "data_vencimento_util": "2025-07-07", "data_processamento": "2024-05-15 12:55:21", "data_prestacao_inicial": "2025-06-05", "data_prestacao_final": "2025-07-04", "data_cancelamento": null, "data_pagamento": null, "valor_original": "99.90", "acrescimo": "0.00", "desconto": "0.00", "desconto_ate_vencimento": "0.00", "valor": "99.90", "valor_juros_pago": "0.00", "valor_multa_paga": "0.00", "valor_pago": "0.00", "isGerenciaNet": false, "isBoletoFacil": false, "isIugu": false, "nosso_numero": "356589", "registrada": "0", "linha_digitavel": "00000.00000 00000.000000 00000.000000 0 00000000000000", "qrcode_copy_paste": "", "gerencianet_html_link": null, "url_pdf_fatura": "http://IP_RADIUSNET/radiusnet/index.php/api/v1/ftp/591000", "url_pdf_boleto": "http://IP_RADIUSNET/radiusnet/index.php/api/v1/bc/591000", "itensAvulsa": [], "itensPlano": [ { "id_cobranca_plano": "1235458", "valor": "99.90", "acrescimo": null, "desconto": null, "juros_configurado": "1.00", "multa_configurada": "2.00", "valor_pago": null, "valor_ate_vencimento": null, "plano": "FIBRA 500 MEGAS", "prorata": "0", "obs_acresc_desc": null, "juros_pagar": 0, "multa_pagar": 0, "valor_atualizado": "99.90" } ], "valor_juros_a_pagar": "0.00", "valor_multa_a_pagar": "0.00", "isVencido": false } ], "count": 1 }
CLIQUE AQUI
============== /v1/cbdt? tipo_data=data_vencimento& data_inicio=2025-06-01& data_fim=2025-06-05& em_aberto=todos& status_cliente=1& apenas_em_atraso=todos& tipo_resultado=detalhado& pagina=1& limite=1 ============== { "rows": [ { "id_cliente_plano": "15022", "pago": "0", "id_cobranca": "11000", "periodo_prestacao": "05/2025", "tipo_pagamento": "Boleto", "status_cliente": "Ativo", "data_vencimento": "2025-06-01", "data_vencimento_util": "2025-06-02", "data_processamento": "2024-06-02 18:06:21", "data_prestacao_inicial": "2025-05-01", "data_prestacao_final": "2025-05-31", "data_cancelamento": null, "data_pagamento": null, "valor_original": "89.90", "acrescimo": "0.00", "desconto": "9.99", "desconto_ate_vencimento": "0.00", "valor": "84.83", "valor_juros_pago": "0.00", "valor_multa_paga": "0.00", "valor_pago": "0.00", "isGerenciaNet": true, "isBoletoFacil": false, "isIugu": false, "nosso_numero": null, "registrada": "0", "linha_digitavel": null, "qrcode_copy_paste": "00000000000000000004BR.GOV.BCB.PIX0000qrcodespix.sejaefi.com.br/bolix/v2/cobv/0****************************************************0000000", "gerencianet_html_link": null, "url_pdf_fatura": "http://IP_RADIUSNET/radiusnet/index.php/api/v1/ftp/11000", "url_pdf_boleto": "http://IP_RADIUSNET/radiusnet/index.php/api/v1/bc/11000", "itensAvulsa": [], "itensPlano": [ { "id_cobranca_plano": "208821", "valor": "19.90", "acrescimo": "0.00", "desconto": "3.33", "juros_configurado": "1.00", "multa_configurada": "5.00", "valor_pago": null, "valor_ate_vencimento": "0.00", "plano": "ESSENCIAL", "prorata": "0", "obs_acresc_desc": "FIDELIDADE", "juros_pagar": "0.19", "multa_pagar": "0.83", "valor_atualizado": "17.59" }, { "id_cobranca_plano": "208824", "valor": "35.00", "acrescimo": "0.00", "desconto": "3.33", "juros_configurado": "1.00", "multa_configurada": "5.00", "valor_pago": null, "valor_ate_vencimento": "0.00", "plano": "REPETIDOR MESH / CAMERA MIBO", "prorata": "0", "obs_acresc_desc": "FIDELIDADE", "juros_pagar": "0.37", "multa_pagar": "1.58", "valor_atualizado": "33.62" }, { "id_cobranca_plano": "208868", "valor": "35.00", "acrescimo": "0.00", "desconto": "3.33", "juros_configurado": "1.00", "multa_configurada": "5.00", "valor_pago": null, "valor_ate_vencimento": "0.00", "plano": "ATENDIMENTO PREMIUM", "prorata": "0", "obs_acresc_desc": "FIDELIDADE", "juros_pagar": "0.37", "multa_pagar": "1.58", "valor_atualizado": "33.62" } ], "valor_juros_a_pagar": "0.93", "valor_multa_a_pagar": "3.99", "isVencido": true, "promessa_pagamento": false, "data_promessa_pagamento": false } ], "count": 1 }
Este endpoint retorna as cobranças de acordo com o período desejado.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet/index.php/api/v1/cbdt?tipo_data=TIPO_DATA&data_inicio=DATA_INICIO&data_fim=DATA_FIM&em_aberto=EM_ABERTO&status_cliente=STATUS_CLIENTE&apenas_em_atraso=APENAS_EM_ATRASO&tipo_resultado=TIPO_RESULTADO&pagina=PAGINA&limite=LIMITE
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| TIPO_DATA | Query | Sim | Tipo de data desejada |
| DATA_INICIO | Query | Sim | Data de início do tipo de data escolhido |
| DATA_FIM | Query | Sim | Data final do tipo de data escolhido |
| EM_ABERTO | Query | Sim | Se a cobrança está em aberto (não liquidada ativa) ou não (liquidada/cancelada). |
| STATUS_CLIENTE | Query | Sim | Status do cadastro do cliente. |
| APENAS_EM_ATRASO | Query | Não | Se deseja visualizar apenas cobranças em atraso (combinar com a query em_aberto = sim, caso deseje apenas em atraso não pagas) |
| TIPO_RESULTADO | Query | Sim | Se deseja visualizar apenas as informações principais ou o relatório completo |
| PAGINA | Query | Não | Número da página para paginação. Default é 1. |
| LIMITE | Query | Não | Número de registros por página. Default é 500, limite máximo é 500. |
Códigos para definir o status do cliente
| Códigos para definir o status do cliente | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
| Valores para TIPO_DATA | Descrição |
|---|---|
| data_vencimento | Data de Vencimento. |
| data_pagamento | Data de Pagamento. |
| data_processamento | Data de Processamento. |
| periodo_prestacao | Período de Prestação. |
| data_prestacao_inicial | Data de Prestação Inicial. |
| data_prestacao_final | Data de Prestação Final. |
| data_cancelamento | Data de Cancelamento. |
| DATA_INICIO | Descrição |
|---|---|
| YYYY-MM-DD | Exemplo: 2025-05-10 |
| DATA_FIM | Descrição |
|---|---|
| YYYY-MM-DD | Exemplo: 2025-05-15 |
| EM_ABERTO | Descrição |
|---|---|
| sim | Não Liquidadas ativas |
| nao | Liquidadas/Canceladas |
| todos | Todas (liquidadas/canceladas ou não) |
| APENAS_EM_ATRASO | Descrição |
|---|---|
| sim | Apenas cobranças com o pagamento em atraso |
| todos | Todas (Cobranças com o pagamento atrasado ou não) |
| TIPO_RESULTADO | Descrição |
|---|---|
| simplificado | Retornará apenas as informações principais da cobrança |
| detalhado | Retornará as informações detalhadas da cobrança, incluindo os itens de cobranças plano e cobranças avulsas |
41. (v1/cpos) Obter O.S por Cliente/Plano
curl "http://IP_RADIUSNET/radiusnet5/index.php/api/v1/cpos/ID_CLIENTE_PLANO" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [ { "id_ordem_servico": "1289", "protocolo": "2024031309492382", "protocolo_atendimento": "", "id_cliente_plano": "1465", "data_abertura": "2024-03-13 10:48:14", "data_limite": "2024-03-13 21:48:14", "data_finalizacao": "2024-03-13 15:22:08", "data_execucao": "2024-03-13", "hora_execucao": "15:30:00", "hora_termino": "10:15:00", "valor_instalacao": null, "valor_mensalidade": null, "id_cobranca_instalacao": null, "id_cobranca_mensaldiade": null, "descricao": "reconfiguração do ppoe do cliente ", "resolucao_atendimento": "Encerrado com sucesso", "status_finalizacao": "Não finalizada", "prioridade": "Média", "reaberto": "Não", "status": "Finalizada" }, { "id_ordem_servico": "1279", "protocolo": "2024031113175186", "protocolo_atendimento": "", "id_cliente_plano": "1465", "data_abertura": "2024-03-11 14:17:51", "data_limite": "2024-03-12 01:17:51", "data_finalizacao": "2024-03-11 15:14:18", "data_execucao": "2024-03-11", "hora_execucao": "00:15:00", "hora_termino": "01:15:00", "valor_instalacao": "0.00", "valor_mensalidade": "0.00", "id_cobranca_instalacao": null, "id_cobranca_mensaldiade": null, "descricao": "ok", "resolucao_atendimento": "Encerrado com sucesso", "status_finalizacao": "Finalizada com Sucesso", "prioridade": "Alta", "reaberto": "Não", "status": "Finalizada" } ], "count": 2 }
Retorna as O.S. de acordo com o Código Cliente/Plano
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet5/index.php/api/v1/cpos/ID_CLIENTE_PLANO
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| ID_CLIENTE_PLANO | Path | Sim | Código cliente/Plano deseja visualizar as O.S |
42. (v1/tos) Obter O.S por Tipo
curl "http://IP_RADIUSNET/radiusnet5/index.php/api/v1/tos/ID_TIPO_OS/PAGINACAO" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": [ { "id_ordem_servico": "1683", "protocolo": "2024101521162489", "protocolo_atendimento": "", "id_cliente_plano": "1674", "data_abertura": "2024-10-15 22:16:56", "data_limite": "2024-10-16 09:16:56", "data_finalizacao": "2025-05-13 10:59:17", "data_execucao": "2025-05-13", "hora_execucao": "19:00:00", "hora_termino": "19:00:00", "valor_instalacao": null, "valor_mensalidade": null, "id_cobranca_instalacao": null, "id_cobranca_mensaldiade": null, "descricao": "grgthtg", "resolucao_atendimento": "Encerrado com sucesso", "status_finalizacao": "Finalizada com Sucesso", "prioridade": "Alta", "reaberto": "Não", "status": "Finalizada" }, { "id_ordem_servico": "1682", "protocolo": "2024101521000254", "protocolo_atendimento": "", "id_cliente_plano": "363", "data_abertura": "2024-10-15 22:00:39", "data_limite": "2024-10-16 09:00:39", "data_finalizacao": "2025-05-13 10:59:18", "data_execucao": "2025-05-13", "hora_execucao": "19:00:00", "hora_termino": "19:00:00", "valor_instalacao": null, "valor_mensalidade": null, "id_cobranca_instalacao": null, "id_cobranca_mensaldiade": null, "descricao": "grgthtg", "resolucao_atendimento": "Encerrado com sucesso", "status_finalizacao": "Finalizada com Sucesso", "prioridade": "Alta", "reaberto": "Não", "status": "Finalizada" } ... ], "count": 200 }
Retorna as O.S. de acordo com o tipo (TIPO_OS), sendo (1 - Normal, 2 - Instalação, 3 - Retirada).
Retornando 200 O.S por pagina.
Method
GET
Solicitação HTTP
GET http://IP_RADIUSNET/radiusnet5/index.php/api/v1/tos/ID_TIPO_OS/PAGINACAO
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| ID_TIPO_OS | Path | Sim | Código Tipo OS que deseja retornar. |
| Pagina | Path | Não | Número da pagina que deseja visulizar, limite ate 200 registros por pagina. |
43. (v1/tios) Obter Todas as Imagens da O.S
curl "https://IP_DOMINIO/radiusnet5/index.php/api/v1/tios/ID_OS" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": { "id_os": "622809", "protocolo": "555522223333", "imagens": [ "https://IP_DOMINIO/other/uploads/cdt_os/555522223333/2164995/1_a803ad72060a7f143513ed91f47b56ce_convert.jpg", "https://IP_DOMINIO/other/uploads/cdt_os/555522223333/2164995/2_872ca7e98eed4b0b96ccb191694c229a_convert.jpg", "https://IP_DOMINIO/other/uploads/cdt_os/555522223333/2164995/3_150cb01d77d8111044bb5c5d3589a651_convert.jpg", "https://IP_DOMINIO/other/uploads/cdt_os/555522223333/2164995/assinaturaOS_convert.jpg" ] }, "count": 3 }
A consulta deve acontecer através do ID da O.S.
Considerando todos os tipos de ordens de serviço: padrão, instalação, retirada. Sendo assim retornando todas imagens vinculados a O.S.
Method
GET
Solicitação HTTP
GET https://IP_DOMINIO/radiusnet5/index.php/api/v1/tios/ID_OS
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| ID_OS | Path | Sim | Código OS que deseja retornar as imagens. |
44. (v1/cpcd) Obter Dados Cadastrais do Cliente
curl "https://IP_DOMINIO/radiusnet5/index.php/api/v1/cpcd/cli/ID_CLIENTE" -H "RTOKEN: CHAVE_API"
curl "https://IP_DOMINIO/radiusnet5/index.php/api/v1/cpcd/cp/ID_CLIENTE_PLANO" -H "RTOKEN: CHAVE_API"
O comando acima retorna o JSON estruturado conforme a seguir:
CLIQUE AQUI
{ "rows": { "id_cliente": "1266", "nome": "JOÃO SILVA SANTOS", "cpf_cnpj_cliente": "12345678901", "nome_representante_legal": "", "cpf_representante_legal": "", "data_cadastro": "2020-08-10 16:09:46", "nome_fantasia": "", "nome_social": "", "rg_cliente": "1234567", "data_nascimento": "1985-03-20", "inscricao_estadual": "", "inscricao_municipal": "", "estrangeiro": "Não", "status_cliente": "Arquivado", "tipo_pessoa": "Pessoa Física", "genero": "", "restringir_recebimento_email": "Não", "restringir_recebimento_sms": "Não", "observacao": "", "emails": [ "joao.teste@exemplo.com.br" ], "telefones": [ "(11) 999999999" ], "enderecos": [ { "logradouro": "Rua das Flores Imaginárias", "numero": "123", "complemento": "próximo ao parque fictício", "bairro": "Vila Exemplo", "cidade": "São Paulo", "estado": "SP", "cep": "01234567" } ] }, "count": 22 }
A consulta deve acontecer através do ID CLIENTE ou ID CLIENTE PLANO.
Caso informar o parametro cli informar ID_CLIENTE
ou
Caso informar o parametro cp informar o ID_CLIENTE_PLANO
Esses endpoints retornar os dados cadastrais do cliente.
Method
GET
Solicitação HTTP
GET https://IP_DOMINIO/radiusnet5/index.php/api/v1/cpcd/cli/ID_CLIENTE
ou
GET https://IP_DOMINIO/radiusnet5/index.php/api/v1/cpcd/cp/ID_CLIENTE_PLANO
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| RTOKEN | Header | Sim | Chave de autorização para acesso a API. |
| ID_CLIENTE | Path | Sim | Código Cliente. |
| ID_CLIENTE_PLANO | Path | Sim | Código Cliente/Plano. |
ERROS
A API RadiusNet pode retornar os seguintes códigos de erro:
| Código | Descrição |
|---|---|
| 200 OK. | A chamada foi bem sucedida. |
| 400 Bad Request | A requisição é inválida, em geral conteúdo mal formado. |
| 401 Unauthorized | O token de acesso é inválidos. |
| 403 Forbidden | O acesso à API está bloqueado ou o usuário está bloqueado. |
| 404 Not Found | O endereço acessado não existe. |
| 429 Too Many Requests | A chave de API atingiu o limite de requisições. |
| 500 Internal Server Error | O servidor encontrou um erro ao processar sua solicitação. |
| 501 Not Implemented | O método solicitado não está implementado. |