developers.rbxsoft.com
Open in
urlscan Pro
192.185.209.38
Public Scan
URL:
https://developers.rbxsoft.com/
Submission: On March 31 via api from US — Scanned from US
Submission: On March 31 via api from US — Scanned from US
Form analysis 0 forms found in the DOM
Text Content
NAV
* Introdução
* Configuração
* Tipos de ambiente
* Serviços v1.0
* Atendimentos
* Cadastro de atendimentos
* Consulta atendimentos
* Consulta causas de atendimentos
* Consulta checklist de atendimentos
* Consulta fluxos de atendimentos
* Consulta grupos de SLA
* Consulta ocorrências de atendimentos
* Consulta tópicos de atendimentos
* Autenticações
* Consulta autenticações de clientes
* Consulta autenticações de clientes (Com senha)
* Clientes
* Alteração de clientes
* Alteração de mercados
* Cadastro de clientes
* Cadastro de mercados
* Consulta clientes
* Consulta clientes bloqueados
* Consulta clientes com redução de banda
* Consulta clientes on-line
* Consulta complementos de contatos
* Consulta contatos
* Consulta dados adicionais de clientes, contratos e atendimentos
* Consulta dados de cobrança de clientes
* Consulta equipamentos on-line
* Consulta grupos de clientes
* Consulta mercados
* Contratos
* Consulta concorrência
* Consulta contratos
* Consulta contratos bloqueados
* Consulta motivos de cancelamento
* Estoque
* Consulta modelos de produtos
* Consulta tipos de produtos
* Consulta unidades de produtos
* Financeiro
* Cadastro de notas fiscais
* Consulta cartões cadastrados
* Consulta ciclos de faturamento
* Consulta documentos baixados
* Consulta documentos em aberto
* Consulta grupos de cobrança
* Consulta linha digitável do boleto
* Variados
* Cadastro de pedidos
* Consulta dados adicionais
* Consulta eventos do FailOver
* Consulta fornecedores
* Consulta planos
* Consulta QoS
* Consulta status do NAS
* Consulta usuários do sistema
* Serviços v2.0
* Documentation Powered by RBXSoft
INTRODUÇÃO
Este manual tem por objetivo definir as especificações técnicas necessárias para
a integração entre os sistemas de informações de terceiros e o os Web Services
do RBXSoft ISP. No contexto deste manual, os Web Services estão disponíveis no
servidor do cliente que possui o RBXSoft ISP instalado. A disponibilidade dos
serviços na nuvem estará condicionada às tratativas de firewall do próprio
servidor.
Os Web Services descritos neste manual foram desenvolvidos no padrão REST + JSON
e o método utilizado para todos os serviços deve ser o POST.
O nome do serviço é definido no corpo da mensagem.
Estes Web Services requerem que o RBXSoft ISP esteja rodando em um servidor
seguro (com SSL), por motivos de segurança.
A codificação dos caracteres do JSON será sempre UTF-8.
A seguir, serão listados os Web Services disponíveis a partir da versão 6.2.003
do sistema.
CONFIGURAÇÃO
A configuração dos Web Services deverá ser feita através da interface web do
RBXSoft ISP, no menu Empresa > Parâmetros > Web Services.
Poderão ser geradas várias instâncias de Web Services. Para isso, cada uma delas
será identificada através de uma chave de acesso exclusiva. Cada chave de acesso
terá permissão de executar determinados serviços, conforme configurado na
interface web e determinará o tipo de ambiente no qual as operações estão sendo
realizadas – de homologação ou produção.
TIPOS DE AMBIENTE
Existem dois tipos de ambiente disponíveis: Homologação e Produção.
O ambiente de homologação deve ser utilizado para a realização de testes de
integração dos sistemas de terceiros com os Web Services. Neste ambiente, todas
as validações são realizadas de forma real, mas os cadastros não são
persistidos. O serviço retornará dados fictícios apenas para validação.
O ambiente de produção é destinado para a realização de cadastros reais no
RBXSoft ISP.
SERVIÇOS V1.0
Para os serviços desta versão (v1.0), a chave de integração deverá ser enviada
no corpo da requisição, em um campo chamado ChaveIntegracao.
Os serviços de consulta sempre irão retornar uma lista de valores, conforme o
serviço solicitado. A estrutura da mensagem de solicitação é padrão para todos
os serviços de consulta, mas cada um possui uma estrutura de mensagem de retorno
específica.
Além do campo de autenticação, o único campo disponível para os serviços de
consulta é o campo Filtro. O filtro consiste na cláusula WHERE de uma query SQL
e pode conter todos os nomes dos campos retornados na consulta, bem como
operadores lógicos e funções suportados pelo banco de dados MYSQL.
ATENDIMENTOS
CADASTRO DE ATENDIMENTOS
O objetivo deste serviço é realizar o cadastro de um novo atendimento no RBX.
> Request Example:
Copy to Clipboard{
"AtendimentoCadastro": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"DadosAtendimento": {
"Data_Abertura": "2023-12-01",
"Hora_Abertura": "10:00:00",
"Iniciativa": "C",
"Modo": "T",
"TipoCliente": "C",
"Cliente": "1",
"Contrato": "7480",
"Contato": "",
"Prioridade": "1",
"Situacao": "A",
"Tipo": "T",
"Topico": "2",
"Assunto": "Sem internet",
"Usuario_Abertura": "joao.silva"
}
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": {
"NumeroAtendimento": "2382854",
"SLA": "600",
"SLA_Tipo": "C",
"Mensagem": "Atendimento cadastrado com sucesso"
}
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 223,
"erro_inf": "",
"erro_desc": "Campo Estimulo_Marketing so pode ser informado para atendimentos do tipo Comercial",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 AtendimentoCadastro Sim Raiz -
Nome do serviço. B01 DadosAtendimento Sim A01 - Dados do atendimento. B02
Data_Abertura Sim B01 Data Data de abertura do atendimento. B03 Hora_Abertura
Sim B01 Hora Hora de abertura do atendimento. B04 Iniciativa Sim B01 Texto
Iniciativa do atendimento. Valores permitidos: C: Cliente; A: Atendente. B05
Modo Sim B01 Texto Modo do atendimento. Informar o código de um dos modos
cadastrados no RBX. B06 Estimulo_Marketing Não B01 Número Código de um dos
estímulos de marketing cadastrados no RBX. Só deve ser informado para
atendimentos do tipo Comercial (Campo B13). B07 TipoCliente Sim B01 Texto Tipo
do cliente. Valores permitidos: C: Cliente; M: Mercado. B08 Cliente Sim B01
Número Código do cliente ou mercado. B09 Contrato Não B01 Número Número de um
dos contratos do cliente, quando o campo B08 for igual a C. B10 Contato Não B01
Número Código de um dos contatos do cliente/mercado. B11 Prioridade Não B01
Número Prioridade do atendimento. B12 Situacao Não B01 Texto Situação do
atendimento. Valores permitidos: A: Em Andamento; E: Em Espera. B13 Tipo Não B01
Texto Informar apenas quando o Tópico for informado (Campo B14). Não informar
quando o Fluxo for informado (Campo B14a). Valores permitidos: A:
Administrativo/Financeiro; C: Comercial; T: Técnico. B14 Topico Não B01 Número
Código de um dos tópicos ativos cadastrados no RBX para o tipo informado no
campo B13. B14a Fluxo Não B01 Número Código de um dos fluxos ativos cadastrados
no RBX. Não informar quando o Tópico for informado (Campo B14). B15 Assunto Sim
B01 Texto Assunto do atendimento. B16 Ocorrencia Não B01 Texto Ocorrência do
atendimento. B17 Usuario_Abertura Não B01 Texto Usuário de abertura do
atendimento. Deve ser um usuário cadastrado no RBX. Quando não informado, o
atendimento será aberto com o usuário routerbox.
CONSULTA ATENDIMENTOS
O objetivo deste serviço é retornar uma lista com os atendimentos cadastrados no
RBX.
> Request Example:
Copy to Clipboard{
"ConsultaAtendimentos": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Atendimentos.Cliente = '10'"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Numero": "446",
"Protocolo": "2023000000000446",
"Abertura_DataHora": "2024-01-20 00:03:09",
"Abertura_Usuario": "routerbox",
"Designacao_Tipo": "usuario",
"Designacao_Usuario": "joao.silva",
"Designacao_Grupo_Id": "0",
"Designacao_Grupo_Nome": "",
"Situacao_OS": "",
"Topico": "(Retirar Equipam) Retirar Equipamento",
"Assunto": "Retirar equipamento do cliente.",
"Solucao": "",
"Encerramento_DataHora": "",
"Causa": "",
"Tipo": "T",
"TipoCliente": "C",
"CodigoCliente": "10"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaAtendimentos Sim Raiz -
Nome do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Numero Número Número do atendimento. Protocolo Número
Número do protocolo do atendimento. Abertura_DataHora Data/Hora Data e hora da
abertura do atendimento. Abertura_Usuario Texto Usuário de abertura do
atendimento. Designacao_Tipo Texto Tipo de designação do atendimento. Será
retornado usuario, grupo ou vazio. Designacao_Usuario Texto Usuário para o qual
o atendimento está designado. Designacao_Grupo_Id Texto Id do grupo de usuários
para o qual o atendimento está designado. Designacao_Grupo_Nome Texto Nome do
grupo de usuários para o qual o atendimento está designado. Situacao_OS Texto
Situação da ordem de serviço: F: Na fila; A: A caminho; E: Em execução; P:
Pausado; C: Concluído; B: Abortado.
Se não for retornado nenhum dos valores acima isso significa que o atendimento
não possui uma ordem de serviço vinculada. Topico Texto Tópico do atendimento.
Assunto Texto Assunto do atendimento. Solucao Texto Solução do atendimento.
Encerramento_DataHora Data/Hora Data e hora do encerramento do atendimento.
Causa Texto Causa de encerramento do atendimento. Tipo Texto Tipo do
atendimento: A: Administrativo/Financeiro; C: Comercial; T: Técnico. TipoCliente
Texto Tipo do cliente: C: Cliente; M: Mercado. CodigoCliente Número Código do
cliente/mercado.
FILTROS DISPONÍVEIS
Campo Tipo Observações Abertura_DataHora Data/Hora Atendimentos.Data_AB
Atendimentos.Hora_AB Abertura_Usuario Texto Atendimentos.Usu_abertura
Designacao_Usuario Texto Atendimentos.Usu_Designado Designacao_Grupo_Id Texto
Atendimentos.Grupo_Designado Designacao_Grupo_Nome Texto
UsuariosGrupoSetor.Grupo Situacao_OS Texto Atendimentos.SituacaoOS Topico Texto
AtendT.Nome
AtendT.Descricao Assunto Texto Atendimentos.Assunto Solucao Texto
Atendimentos.Solucao Encerramento_DataHora Data/Hora Atendimentos.Data_BX
Atendimentos.Hora_BX Causa Texto AtendC.Nome
AtendC.Descricao Tipo Texto Atendimentos.Tipo TipoCliente Texto
Atendimentos.TipoCli CodigoCliente Número Atendimentos.Cliente
CONSULTA CAUSAS DE ATENDIMENTOS
O objetivo deste serviço é retornar uma lista com as causas de atendimento
cadastrados no RBX.
> Request Example:
Copy to Clipboard{
"ConsultaCausas": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Tipo = 'T'"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Codigo": "2",
"Tipo": "T",
"Nome": "Instalação OK",
"Descricao": "Instalado com Sucesso",
"Situacao": "A"
},
{
"Codigo": "3",
"Tipo": "T",
"Nome": "Configuração OK",
"Descricao": "Configurado com sucesso",
"Situacao": "A"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaCausas Sim Raiz - Nome do
serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Codigo Número Código da causa. Tipo Texto Tipo da causa:
A: Administrativo/Financeiro; C: Comercial; T: Técnico. Nome Texto Nome da
causa. Descricao Texto Descrição da causa. Situacao Texto Situação da causa: A:
Ativa; I: Inativa.
CONSULTA CHECKLIST DE ATENDIMENTOS
O objetivo deste serviço é retornar uma lista com os checklists dos atendimentos
em aberto.
> Request Example:
Copy to Clipboard{
"ConsultaChecklistAtendimentos": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Checklist_Descricao = 'Validação de cadastro'"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Atendimento_Numero": "405",
"Checklist_Id": "1",
"Checklist_Descricao": "Validação de cadastro",
"Checklist_Obrigatorio": "N",
"Checklist_Status": "S"
},
{
"Atendimento_Numero": "407",
"Checklist_Id": "2",
"Checklist_Descricao": "Validação de cadastro",
"Checklist_Obrigatorio": "N",
"Checklist_Status": "N"
},
{
"Atendimento_Numero": "415",
"Checklist_Id": "3",
"Checklist_Descricao": "Validação de cadastro",
"Checklist_Obrigatorio": "N",
"Checklist_Status": "N"
},
{
"Atendimento_Numero": "457",
"Checklist_Id": "4",
"Checklist_Descricao": "Validação de cadastro",
"Checklist_Obrigatorio": "N",
"Checklist_Status": "N"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaChecklistAtendimentos Sim
Raiz - Nome do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Atendimento_Numero Número Número do atendimento.
Checklist_Id Número Id do checklist. Checklist_Descricao Texto Descrição do
checklist. Checklist_Obrigatorio Texto Indica se o checklist é obrigatório: S:
Sim; N: Não. Checklist_Status Texto Indica se o checklist está selecionado no
atendimento: S: Sim; N: Não.
CONSULTA FLUXOS DE ATENDIMENTOS
O objetivo deste serviço é retornar uma lista com os fluxos de atendimentos.
> Request Example:
Copy to Clipboard{
"ConsultaFluxos": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Situacao = 'A'"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Codigo": "1",
"Descricao": "Atendimento ao Cliente",
"Planos": "",
"GruposClientes": "",
"GruposUsuarios": "",
"Situacao": "A"
},
{
"Codigo": "2",
"Descricao": "Pendências Financeiras",
"Planos": "",
"GruposClientes": "",
"GruposUsuarios": "",
"Situacao": "A"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaFluxos Sim Raiz - Nome do
serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Codigo Número Código do fluxo. Descricao Texto Descrição
do fluxo. Planos Texto Filtro de planos dos contratos. GruposClientes Texto
Filtro de grupos de clientes. GruposUsuarios Texto Filtro de grupos de usuários.
Situacao Texto Situação do fluxo: A: Ativo; I: Inativo.
CONSULTA GRUPOS DE SLA
O objetivo deste serviço é retornar uma lista com os grupos de SLA cadastrados
no RBX. Atenção: este serviço não possui suporte a filtros.
> Request Example:
Copy to Clipboard{
"ConsultaGruposSLA": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
}
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Codigo": "-1",
"Descricao": "SLA Padrão",
"Situacao": "A"
},
{
"Codigo": "1",
"Descricao": "SLA Avançado",
"Situacao": "A"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 97,
"erro_inf": "",
"erro_desc": "Erro de integracao",
"erro_detail": "Chave de integracao invalida ou inativa",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaGruposSLA Sim Raiz - Nome
do serviço.
CAMPOS DO RETORNO
Campo Tipo Observações Codigo Número Código do grupo. Descricao Texto Descrição
do grupo. Situacao Texto Situação do grupo: A: Ativo; I: Inativo.
CONSULTA OCORRÊNCIAS DE ATENDIMENTOS
O objetivo deste serviço é retornar uma lista com as ocorrências dos
atendimentos.
> Request Example:
Copy to Clipboard{
"ConsultaOcorrenciasAtendimentos": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Atendimento = 2"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Id": "2",
"Data": "2024-01-20 10:00:00",
"Descricao": "Abertura de atendimento via central do assinante mobile",
"Modo": "A",
"Usuario": "routerbox",
"Latitude": "",
"Longitude": "",
"Atendimento_Numero": "2"
},
{
"Id": "5",
"Data": "2024-01-20 10:01:00",
"Descricao": "Inclusão de anexo",
"Modo": "A",
"Usuario": "joao.silva",
"Latitude": "",
"Longitude": "",
"Atendimento_Numero": "2"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaOcorrenciasAtendimentos
Sim Raiz - Nome do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Id Número Id da ocorrência. Data Data/Hora Data e hora da
ocorrência. Descricao Texto Descrição da ocorrência (Pode conter tags HTML).
Modo Texto Modo de registro da ocorrência: A: Automático; M: Manual. Usuario
Texto Usuário da ocorrência. Latitude Decimal(16.13) Latitude da ocorrência
(Apenas quando a ocorrência foi registrada via RBX Workforce). Longitude
Decimal(16.13) Longitude da ocorrência (Apenas quando a ocorrência foi
registrada via RBX Workforce). Atendimento_Numero Número Número do atendimento.
FILTROS DISPONÍVEIS
Campo Tipo Observações Data Data/Hora Data Descricao Texto Descricao Modo Texto
Modo Usuario Texto Usuario Latitude Decimal(16.13) MapsLat Longitude
Decimal(16.13) MapsLng Atendimento_Numero Número Atendimento
CONSULTA TÓPICOS DE ATENDIMENTOS
O objetivo deste serviço é retornar uma lista com os tópicos de atendimento
cadastrados no RBX.
> Request Example:
Copy to Clipboard{
"ConsultaTopicos": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Tipo = 'T'"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Codigo": "2",
"Tipo": "T",
"Nome": "Nova Instalação",
"Descricao": "Nova Instalação",
"Central": "N",
"Abertura": "T",
"Situacao": "A"
},
{
"Codigo": "3",
"Tipo": "T",
"Nome": "Alterar Senha",
"Descricao": "Solicitação de Alteração de Senha",
"Central": "N",
"Abertura": "T",
"Situacao": "A"
},
{
"Codigo": "4",
"Tipo": "T",
"Nome": "Dados Cadastrais",
"Descricao": "Solicitação de Alteração Cadastral",
"Central": "S",
"Abertura": "T",
"Situacao": "A"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaTopicos Sim Raiz - Nome do
serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Codigo Número Código do tópico. Tipo Texto Tipo do
tópico: A: Administrativo/Financeiro; C: Comercial; T: Técnico. Nome Texto Nome
do tópico. Descricao Texto Descrição do tópico. Central Texto Central do
Assinante: S: Exibir; N: Não Exibir. Abertura Texto Abertura: T: Todos; A:
Avulso; F: Fluxo. Situacao Texto Situação do tópico: A: Ativo; I: Inativo.
AUTENTICAÇÕES
CONSULTA AUTENTICAÇÕES DE CLIENTES
O objetivo deste serviço é retornar uma lista com as autenticações dos clientes.
> Request Example:
Copy to Clipboard{
"ConsultaAutenticacao": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Cliente = '1'"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Id": "1",
"Cliente": "1",
"Contrato": "1",
"NAS": "(CENTRAL ASSINANTE)",
"Porta": "(TODAS)",
"Usuario": "cliente01",
"MAC": "",
"Observacao": ""
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaAutenticacao Sim Raiz -
Nome do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Id Número Id da autenticação. Cliente Número Código do
cliente. Contrato Número Número do contrato. NAS Texto IP do NAS no qual a
autenticação está vinculada. Porta Texto Nome da porta do NAS no qual a
autenticação está vinculada. Usuario Texto Usuário da autenticação. MAC Texto
MAC da autenticação. Observacao Texto Observação da autenticação.
CONSULTA AUTENTICAÇÕES DE CLIENTES (COM SENHA)
O objetivo deste serviço é retornar uma lista com as autenticações dos clientes
e suas respectivas senhas.
> Request Example:
Copy to Clipboard{
"ConsultaAutenticacaoSenha": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Cliente = '1'"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Id": "1",
"Cliente": "1",
"Contrato": "1",
"NAS": "(CENTRAL ASSINANTE)",
"Porta": "(TODAS)",
"Usuario": "joao.silva",
"Senha": "mudar123",
"MAC": "",
"Observacao": ""
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaAutenticacaoSenha Sim Raiz
- Nome do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Id Número Id da autenticação. Cliente Número Código do
cliente. Contrato Número Número do contrato. NAS Texto IP do NAS no qual a
autenticação está vinculada. Porta Texto Nome da porta do NAS no qual a
autenticação está vinculada. Usuario Texto Usuário da autenticação. Senha Texto
Senha da autenticação. MAC Texto MAC da autenticação. Observacao Texto
Observação da autenticação.
CLIENTES
ALTERAÇÃO DE CLIENTES
O objetivo deste serviço é alterar o cadastro de um cliente existente no RBX,
enviando apenas os dados que deverão ser alterados.
> Request Example:
Copy to Clipboard{
"ClienteAlteracao": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"DadosCliente": {
"Codigo": 41,
"Nome": "João da Silva"
}
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": {
"CodigoCliente": "41",
"Mensagem": "Cliente alterado com sucesso"
}
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 4,
"erro_inf": "",
"erro_desc": "Codigo do inválido ",
"erro_detail": "CodigoCliente",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ClienteAlteracao Sim Raiz - Nome
do serviço. B01 DadosCliente Sim Raiz - Dados do cliente. B02 Codigo Sim B01
Número Código do cliente que será alterado. B03 TipoPessoa Não B01 Texto Tipo de
pessoa. Valores permitidos: P: Pessoa Física; J: Pessoa Jurídica. B04 CPF Não
B01 Texto CPF do cliente. B04a CNPJ Não B01 Texto CNPJ do cliente. B05 Nome Não
B01 Texto Nome do cliente. B06 Endereco Não B01 Texto Endereço do cliente. B07
EndNumero Não B01 Número Número do endereço. B08 Complemento Não B01 Texto
Complemento do endereço. B09 Bairro Não B01 Texto Bairro do endereço. B10
CodMunicipio Não B01 Número Código do município do cliente de acordo com a
tabela de municípios do IBGE. B11 Distrito Não B01 Texto Nome do distrito. B12
UF Não B01 Texto UF do endereço. B13 CEP Não B01 Número CEP do endereço. B14
TelComercial Não B01 Número Número do telefone comercial. B15 TelResidencial Não
B01 Número Número do telefone residencial. B16 TelCelular Não B01 Número Número
do telefone celular. B17 Banco Não B01 Número Local de cobrança padrão do
cliente. Informar o código de um dos bancos cadastrados no RBX. B18 RG Não B01
Texto RG. Este campo só deve ser informado se no campo B03 foi informado o valor
P. B18a IE Não B01 Texto Inscrição Estadual. Este campo só deve ser informado se
no campo B03 foi informado o valor J. B19 Nascimento Não B01 Data Data de
nascimento para pessoa física ou data de criação para pessoa jurídica. B20
CodCobr Não B01 Texto Código de cobrança do cliente junto ao banco, quando
houver. B21 Cobranca Não B01 Texto Tipo de cobrança. Valores permitidos: S:
Cobrança Simples; R: Cobrança Registrada; D: Débito em Conta; C: Cartão de
Crédito. B22 CobrCartaoId Não B01 Número Id do cartão de crédito do cliente que
será utilizado para cobranças recorrentes. B23 TipoImpressao Não B01 Texto Tipo
de impressão. Valores permitidos: B: Boleto; C: Carnê. B24 Convenio Não B01
Número Código do convênio bancário cadastrado para o banco informado no campo
B17. B25 TipoAssinante Não B01 Número Tipo de assinante. Valores permitidos: 1:
Comercial/Industrial; 2: Poder Público; 3: Residencial/Pessoa Física; 4:
Público; 5: Semi-Público; 6: Outros.
Se este campo não for informado, o cliente será cadastrado automaticamente com o
tipo 1 se for pessoa jurídica ou com o tipo 3 se for pessoa física. B26 CFOP Não
B01 Número CFOP específico para emissão de notas fiscais de serviço de
comunicação (modelo 21). Valores permitidos: 5301: Prestação de serviço de
comunicação para execução de serviço da mesma natureza; 5302: Prestação de
serviço de comunicação a estabelecimento industrial; 5303: Prestação de serviço
de comunicação a estabelecimento comercial; 5304: Prestação de serviço de
comunicação a estabelecimento de prestador de serviço de transporte; 5305:
Prestação de serviço de comunicação a estabelecimento de geradora ou de
distribuidora de energia elétrica; 5306: Prestação de serviço de comunicação a
estabelecimento de produtor rural; 5307: Prestação de serviço de comunicação a
não contribuinte; 6301: Prestação de serviço de comunicação para execução de
serviço da mesma natureza; 6302: Prestação de serviço de comunicação a
estabelecimento industrial; 6303: Prestação de serviço de comunicação a
estabelecimento comercial; 6304: Prestação de serviço de comunicação a
estabelecimento de prestador de serviço de transporte; 6305: Prestação de
serviço de comunicação a estabelecimento de geradora ou de distribuidora de
energia elétrica; 6306: Prestação de serviço de comunicação a estabelecimento de
produtor rural; 6307: Prestação de serviço de comunicação a não contribuinte.
B27 DiaVencimento Não B01 Número Dia de vencimento do faturamento do cliente.
Informar um valor no intervalo de 0 a 31. São aceitos apenas dias de vencimento
existentes nos ciclos de faturamento cadastrados no RBX. B28 DiasProtesto Não
B01 Número Dias para protesto automático do cliente em caso de inadimplência.
B29 DebitoAgencia Não B01 Número Número da agência (com DV) do cliente para as
operações de débito em conta. B30 DebitoOperacao Não B01 Número Número da
operação da conta do cliente para as operações de débito em conta nas cobranças
do banco 104-Caixa Econômica Federal. Valores permitidos: 001: Conta Corrente
Pessoa Física; 003: Conta Corrente Pessoa Jurídica; 013: Conta Poupança Pessoa
Física. B31 DebitoConta Não B01 Número Número da conta corrente (com DV) do
cliente para a operação de débito em conta. B32 Sigla Não B01 Texto Apelido para
pessoa física ou nome fantasia para pessoa jurídica. B33 CobrEndereco Não B01
Texto Endereço de cobrança. B34 CobrEndNumero Não B01 Número Número do endereço
de cobrança. B35 CobrComplemento Não B01 Texto Complemento do endereço de
cobrança. B36 CobrBairro Não B01 Texto Bairro do endereço de cobrança. B37
CobrCidade Não B01 Texto Nome do município do endereço de cobrança. B38 CobrUF
Não B01 Texto UF do endereço de cobrança. B39 CobrCEP Não B01 Número CEP do
endereço de cobrança. B40 Bloqueavel Não B01 Texto Bloqueável. Valores
permitidos: S: Indica que o cliente pode ser bloqueado automaticamente; N:
Indica que o cliente não pode ser bloqueado automaticamente. B41 Negativavel Não
B01 Texto Negativável. Valores permitidos: S: Indica que o cliente pode ser
negativado automaticamente; N: Indica que o cliente não pode ser negativado
automaticamente;
Para utilizar este campo é necessário o módulo do SPC Brasil. B42 AvisoPagamento
Não B01 Texto Aviso de pagamento. Valores permitidos: S: Indica que o cliente
pode comunicar um aviso de pagamento; A: Indica que o cliente pode comunicar um
aviso de pagamento, mas já está em um nível de alerta; N: Indica que o cliente
não pode comunicar um aviso de pagamento. B43 CobrGrupo Não B01 Número Informar
o código de um dos grupos de cobrança cadastrados no RBX. B44 Email Não B01
Texto E-mail principal do cliente. B45 EnviarBoletoEmail Não B01 Texto Informar
S para indicar que o faturamento (boleto/nota fiscal) deverá ser enviado para o
e-mail do cliente. B46 Observacoes Não B01 Texto Observações do cliente. B47
BuscarCoordenadaS Não B01 Texto Buscar coordenadas, onde S indica que no momento
do cadastro, o sistema deverá buscar as coordenadas do endereço do cliente
(latitude/longitude). Esta consulta é realizada através da API do Google Maps.
Caso a integração com o Google Maps esteja desativada, a busca não será
realizada. B48 Latitude Não B01 Decimal(16.13) Latitude do endereço do cliente.
B49 Longitude Não B01 Decimal(16.13) Longitude do endereço do cliente. B50
Servidor Não B01 Número Informar um dos servidores com serviço Gateway
cadastrados no RBX. B51 Grupo Não B01 Número Informar o código de um dos grupos
cadastrados no RBX. B52 TipoAssinante2 Não B01 Número Código necessário para
geração do arquivo fiscal referentes às notas modelos 21 e 22. Valores
permitidos: 01: Comercial; 02: Industrial; 03: Residencial/Pessoa Física; 04:
Produtor Rural; 05: Órgão da administração pública estadual direta e suas
fundações e autarquias, quando mantidas pelo poder público estadual e regidas
por normas de direito público, nos termos do Convênio ICMS 107/95; 06: Prestador
de serviço de telecomunicação responsável pelo recolhimento do imposto incidente
sobre a cessão dos meios de rede do prestador do serviço ao usuário final, nos
termos do Convênio ICMS 17/13; 07: Missões Diplomáticas, Repartições Consulares
e Organismos Internacionais, nos termos do Convênio ICMS 158/94; 08: Igrejas e
Templos de qualquer natureza; 99: Outros não especificados anteriormente.
Se este campo não for informado, o cliente será cadastrado automaticamente com o
tipo 01 se for pessoa jurídica ou com o tipo 03 se for pessoa física; B53
ContribuinteICMS Não B01 Número Código necessário para geração da NF-e.Valores
permitidos: 1: Contribuinte ICMS; 2: Contribuinte ISENTO; 9: Não Contribuinte.
Se este campo não for informado, o cliente será cadastrado automaticamente com o
tipo 1 se possuir Inscrição Estadual ou com o tipo 2 caso não possua. B54
TipoConta Não B01 Texto Define do tipo de conta do cliente. Valores permitidos:
PRE: Pré-pago; POS: Pós-pago. B55 DadosAdicionais Não B01 - Grupo de informação
dos dados adicionais do cliente. C01 DadoAdicional Não B55 - Grupo de informação
dos dados adicionais do cliente. D01 Id Não C01 Número Informar o Id único do
dado adicional no RBX. Este campo é obrigatório quando o cliente possui mais do
que 1 dado adicional com o mesmo código. D02 Codigo Não C01 Número Informar o
código de um dado adicional cadastrado no RBX. D03 Conteudo Não C01 - Informar o
conteúdo do dado adicional respeitando as regras existentes para o mesmo,
conforme cadastrado no RBX. E01 Contatos Não B01 - Grupo de informação dos
contatos do cliente. F01 Contato Não E01 - Grupo de informação dos contatos do
cliente. G01 Codigo Não F01 Número Código do contato que será alterado. G02 Nome
Não F01 Texto Nome do contato. G03 Tipo Não F01 Texto Tipo do contato. Valores
permitidos: G: Geral; A: Administrativo; T: Técnico. G04 Complemento Não F01
Número Informar o código de um complemento cadastrado no RBX. G05 Email Não F01
Texto E-mail do contato. G06 Telefone1 Não F01 Número Primeiro telefone do
contato. G07 Telefone2 Não F01 Número Segundo telefone do contato. G08 Telefone3
Não F01 Número Terceiro telefone do contato. G09 Aniversario Não F01 Data Data
de nascimento do contato. G10 Situacao Não F01 Texto Situação do contato.
Valores permitidos: A: Ativo; I: Inativo.
ALTERAÇÃO DE MERCADOS
O objetivo deste serviço é alterar o cadastro de um mercado existente no RBX,
enviando apenas os dados que deverão ser alterados.
> Request Example:
Copy to Clipboard{
"MercadoAlteracao": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"DadosMercado": {
"Codigo": 1,
"Nome": "João da Silva"
}
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": {
"CodigoMercado": "1",
"Mensagem": "Mercado alterado com sucesso"
}
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 4,
"erro_inf": "",
"erro_desc": "Codigo do inválido ",
"erro_detail": "CodigoMercado",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 MercadoAlteracao Sim Raiz - Nome
do serviço. B01 DadosMercado Sim Raiz - Dados do mercado. B02 Codigo Sim B01
Número Código do mercado que será alterado. B03 TipoPessoa Não B01 Texto Tipo de
pessoa. Valores permitidos: P: Pessoa Física; J: Pessoa Jurídica. B04 CPF Não
B01 Texto CPF do mercado. B04a CNPJ Não B01 Texto CNPJ do mercado. B05 Nome Não
B01 Texto Nome do mercado. B06 Endereco Não B01 Texto Endereço do mercado. B07
EndNumero Não B01 Número Número do endereço. B08 Complemento Não B01 Texto
Complemento do endereço. B09 Bairro Não B01 Texto Bairro do endereço. B10
CodMunicipio Não B01 Número Código do município do mercado de acordo com a
tabela de municípios do IBGE. B11 Distrito Não B01 Texto Nome do distrito. B12
UF Não B01 Texto UF do endereço. B13 CEP Não B01 Número CEP do endereço. B14
TelComercial Não B01 Número Número do telefone comercial. B15 TelResidencial Não
B01 Número Número do telefone residencial. B16 TelCelular Não B01 Número Número
do telefone celular. B17 Banco Não B01 Número Local de cobrança padrão do
mercado. Informar o código de um dos bancos cadastrados no RBX. B18 RG Não B01
Texto RG. Este campo só deve ser informado se no campo B03 foi informado o valor
P. B18a IE Não B01 Texto Inscrição Estadual. Este campo só deve ser informado se
no campo B03 foi informado o valor J. B19 Nascimento Não B01 Data Data de
nascimento para pessoa física ou data de criação para pessoa jurídica. B20
CodCobr Não B01 Texto Código de cobrança do mercado junto ao banco, quando
houver. B21 Cobranca Não B01 Texto Tipo de cobrança. Valores permitidos: S:
Cobrança Simples; R: Cobrança Registrada; D: Débito em Conta; C: Cartão de
Crédito. B22 CobrCartaoId Não B01 Número Id do cartão de crédito do mercado que
será utilizado para cobranças recorrentes. B23 TipoImpressao Não B01 Texto Tipo
de impressão. Valores permitidos: B: Boleto; C: Carnê. B24 Convenio Não B01
Número Código do convênio bancário cadastrado para o banco informado no campo
B17. B25 TipoAssinante Não B01 Número Tipo de assinante. Valores permitidos: 1:
Comercial/Industrial; 2: Poder Público; 3: Residencial/Pessoa Física; 4:
Público; 5: Semi-Público; 6: Outros.
Se este campo não for informado, o mercado será cadastrado automaticamente com o
tipo 1 se for pessoa jurídica ou com o tipo 3 se for pessoa física. B26 CFOP Não
B01 Número CFOP específico para emissão de notas fiscais de serviço de
comunicação (modelo 21). Valores permitidos: 5301: Prestação de serviço de
comunicação para execução de serviço da mesma natureza; 5302: Prestação de
serviço de comunicação a estabelecimento industrial; 5303: Prestação de serviço
de comunicação a estabelecimento comercial; 5304: Prestação de serviço de
comunicação a estabelecimento de prestador de serviço de transporte; 5305:
Prestação de serviço de comunicação a estabelecimento de geradora ou de
distribuidora de energia elétrica; 5306: Prestação de serviço de comunicação a
estabelecimento de produtor rural; 5307: Prestação de serviço de comunicação a
não contribuinte; 6301: Prestação de serviço de comunicação para execução de
serviço da mesma natureza; 6302: Prestação de serviço de comunicação a
estabelecimento industrial; 6303: Prestação de serviço de comunicação a
estabelecimento comercial; 6304: Prestação de serviço de comunicação a
estabelecimento de prestador de serviço de transporte; 6305: Prestação de
serviço de comunicação a estabelecimento de geradora ou de distribuidora de
energia elétrica; 6306: Prestação de serviço de comunicação a estabelecimento de
produtor rural; 6307: Prestação de serviço de comunicação a não contribuinte.
B27 DiaVencimento Não B01 Número Dia de vencimento do faturamento do mercado.
Informar um valor no intervalo de 0 a 31. São aceitos apenas dias de vencimento
existentes nos ciclos de faturamento cadastrados no RBX. B28 DiasProtesto Não
B01 Número Dias para protesto automático do mercado em caso de inadimplência.
B29 DebitoAgencia Não B01 Número Número da agência (com DV) do mercado para as
operações de débito em conta. B30 DebitoOperacao Não B01 Número Número da
operação da conta do mercado para as operações de débito em conta nas cobranças
do banco 104-Caixa Econômica Federal. Valores permitidos: 001: Conta Corrente
Pessoa Física; 003: Conta Corrente Pessoa Jurídica; 013: Conta Poupança Pessoa
Física. B31 DebitoConta Não B01 Número Número da conta corrente (com DV) do
mercado para a operação de débito em conta. B32 Sigla Não B01 Texto Apelido para
pessoa física ou nome fantasia para pessoa jurídica. B33 CobrEndereco Não B01
Texto Endereço de cobrança. B34 CobrEndNumero Não B01 Número Número do endereço
de cobrança. B35 CobrComplemento Não B01 Texto Complemento do endereço de
cobrança. B36 CobrBairro Não B01 Texto Bairro do endereço de cobrança. B37
CobrCidade Não B01 Texto Nome do município do endereço de cobrança. B38 CobrUF
Não B01 Texto UF do endereço de cobrança. B39 CobrCEP Não B01 Número CEP do
endereço de cobrança. B40 Bloqueavel Não B01 Texto Bloqueável. Valores
permitidos: S: Indica que o mercado pode ser bloqueado automaticamente; N:
Indica que o mercado não pode ser bloqueado automaticamente. B41 Negativavel Não
B01 Texto Negativável. Valores permitidos: S: Indica que o mercado pode ser
negativado automaticamente; N: Indica que o mercado não pode ser negativado
automaticamente;
Para utilizar este campo é necessário o módulo do SPC Brasil. B42 AvisoPagamento
Não B01 Texto Aviso de pagamento. Valores permitidos: S: Indica que o mercado
pode comunicar um aviso de pagamento; A: Indica que o mercado pode comunicar um
aviso de pagamento, mas já está em um nível de alerta; N: Indica que o mercado
não pode comunicar um aviso de pagamento. B43 CobrGrupo Não B01 Número Informar
o código de um dos grupos de cobrança cadastrados no RBX. B44 Email Não B01
Texto E-mail principal do mercado. B45 EnviarBoletoEmail Não B01 Texto Informar
S para indicar que o faturamento (boleto/nota fiscal) deverá ser enviado para o
e-mail do mercado. B46 Observacoes Não B01 Texto Observações do mercado. B47
BuscarCoordenadaS Não B01 Texto Buscar coordenadas, onde S indica que no momento
do cadastro, o sistema deverá buscar as coordenadas do endereço do mercado
(latitude/longitude). Esta consulta é realizada através da API do Google Maps.
Caso a integração com o Google Maps esteja desativada, a busca não será
realizada. B48 Latitude Não B01 Decimal(16.13) Latitude do endereço do mercado.
B49 Longitude Não B01 Decimal(16.13) Longitude do endereço do mercado. B50
Servidor Não B01 Número Informar um dos servidores com serviço Gateway
cadastrados no RBX. B51 Grupo Não B01 Número Informar o código de um dos grupos
cadastrados no RBX. B52 TipoAssinante2 Não B01 Número Código necessário para
geração do arquivo fiscal referentes às notas modelos 21 e 22. Valores
permitidos: 01: Comercial; 02: Industrial; 03: Residencial/Pessoa Física; 04:
Produtor Rural; 05: Órgão da administração pública estadual direta e suas
fundações e autarquias, quando mantidas pelo poder público estadual e regidas
por normas de direito público, nos termos do Convênio ICMS 107/95; 06: Prestador
de serviço de telecomunicação responsável pelo recolhimento do imposto incidente
sobre a cessão dos meios de rede do prestador do serviço ao usuário final, nos
termos do Convênio ICMS 17/13; 07: Missões Diplomáticas, Repartições Consulares
e Organismos Internacionais, nos termos do Convênio ICMS 158/94; 08: Igrejas e
Templos de qualquer natureza; 99: Outros não especificados anteriormente.
Se este campo não for informado, o mercado será cadastrado automaticamente com o
tipo 01 se for pessoa jurídica ou com o tipo 03 se for pessoa física; B53
ContribuinteICMS Não B01 Número Código necessário para geração da NF-e.Valores
permitidos: 1: Contribuinte ICMS; 2: Contribuinte ISENTO; 9: Não Contribuinte.
Se este campo não for informado, o mercado será cadastrado automaticamente com o
tipo 1 se possuir Inscrição Estadual ou com o tipo 2 caso não possua. B54
TipoConta Não B01 Texto Define do tipo de conta do mercado. Valores permitidos:
PRE: Pré-pago; POS: Pós-pago. B55 DadosAdicionais Não B01 - Grupo de informação
dos dados adicionais do mercado. C01 DadoAdicional Não B55 - Grupo de informação
dos dados adicionais do mercado. D01 Id Não C01 Número Informar o Id único do
dado adicional no RBX. Este campo é obrigatório quando o mercado possui mais do
que 1 dado adicional com o mesmo código. D02 Codigo Não C01 Número Informar o
código de um dado adicional cadastrado no RBX. D03 Conteudo Não C01 - Informar o
conteúdo do dado adicional respeitando as regras existentes para o mesmo,
conforme cadastrado no RBX. E01 Contatos Não B01 - Grupo de informação dos
contatos do mercado. F01 Contato Não E01 - Grupo de informação dos contatos do
mercado. G01 Codigo Não F01 Número Código do contato que será alterado. G02 Nome
Não F01 Texto Nome do contato. G03 Tipo Não F01 Texto Tipo do contato. Valores
permitidos: G: Geral; A: Administrativo; T: Técnico. G04 Complemento Não F01
Número Informar o código de um complemento cadastrado no RBX. G05 Email Não F01
Texto E-mail do contato. G06 Telefone1 Não F01 Número Primeiro telefone do
contato. G07 Telefone2 Não F01 Número Segundo telefone do contato. G08 Telefone3
Não F01 Número Terceiro telefone do contato. G09 Aniversario Não F01 Data Data
de nascimento do contato. G10 Situacao Não F01 Texto Situação do contato.
Valores permitidos: A: Ativo; I: Inativo.
CADASTRO DE CLIENTES
O objetivo deste serviço é realizar o cadastro de um novo cliente no RBX.
> Request Example:
Copy to Clipboard{
"ClienteCadastro": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"DadosCliente": {
"TipoPessoa": "F",
"CPF": "607.942.320-00",
"Nome": "João da Silva",
"Endereco": "Rua Presidente Nereu Ramos",
"EndNumero": "1001",
"Bairro": "Centro",
"CodMunicipio": "4114807",
"UF": "PR",
"CEP": "86990000",
"TipoImpressao": "C",
"Email": "joao.silva@provedor.com",
"TipoAssinante": "3",
"TipoConta": "POS",
"DadosAdicionais": {
"DadoAdicional": {
"Codigo": "2",
"Valor": "300"
}
},
"Contatos": {
"Contato": [
{
"Nome": "Maria da Silva",
"Tipo": "G",
"Email": "maria.silva@provedor.com"
},
{
"Nome": "Carlos da Silva",
"Tipo": "G",
"Email": "carlos.silva@provedor.com"
}
]
}
}
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": {
"CodigoCliente": "330781",
"Mensagem": "Cliente cadastrado com sucesso"
}
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "Campo obrigatorio nao informado",
"erro_detail": "TipoAssinante",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ClienteCadastro Sim Raiz - Nome do
serviço. B01 DadosCliente Sim A01 - Dados do cliente. B02 TipoPessoa Sim B01
Texto Tipo de pessoa. Valores permitidos: P: Pessoa Física; J: Pessoa Jurídica.
B03 CPF Sim* B01 Texto CPF do cliente. Este campo é obrigatório se no campo B02
foi informado o valor P. B03 CNPJ Sim* B01 Texto CNPJ do cliente. Este campo é
obrigatório se no campo B02 foi informado o valor J. B04 Nome Sim B01 Texto Nome
do cliente. B05 Endereco Não B01 Texto Endereço do cliente. B06 EndNumero Não
B01 Número Número do endereço. B07 Complemento Não B01 Texto Complemento do
endereço. B08 Bairro Não B01 Texto Bairro do endereço. B09 CodMunicipio Sim B01
Número Código do município do cliente de acordo com a tabela de municípios do
IBGE. B10 Distrito Não B01 Texto Nome do distrito. B11 UF Sim B01 Texto UF do
endereço. B12 CEP Não B01 Número CEP do endereço. B13 TelComercial Não B01
Número Número do telefone comercial. B14 TelResidencial Não B01 Número Número do
telefone residencial. B15 TelCelular Não B01 Número Número do telefone celular.
B16 Banco Não B01 Número Local de cobrança padrão do cliente. Informar o código
de um dos bancos cadastrados no RBX. B17 RG Não B01 Texto RG. Este campo só deve
ser informado se no campo B02 foi informado o valor P. B17 IE Não B01 Texto
Inscrição Estadual. Este campo só deve ser informado se no campo B02 foi
informado o valor J. B18 Nascimento Não B01 Data Data de nascimento para pessoa
física ou data de criação para pessoa jurídica. B19 CodCobr Não B01 Texto Código
de cobrança do cliente junto ao banco, quando houver. B20 Cobranca Não B01 Texto
Tipo de cobrança. Valores permitidos: S: Cobrança Simples; R: Cobrança
Registrada; D: Débito em Conta; C: Cartão de Crédito. B21 TipoImpressao Não B01
Texto Tipo de impressão. Valores permitidos: B: Boleto; C: Carnê. B22 Convenio
Não B01 Número Código do convênio bancário cadastrado para o banco informado no
campo B16. B23 TipoAssinante Não B01 Número Tipo de assinante. Valores
permitidos: 1: Comercial/Industrial; 2: Poder Público; 3: Residencial/Pessoa
Física; 4: Público; 5: Semi-Público; 6: Outros.
Se este campo não for informado, o cliente será cadastrado automaticamente com o
tipo 1 se for pessoa jurídica ou com o tipo 3 se for pessoa física. B24 CFOP Não
B01 Número CFOP específico para emissão de notas fiscais de serviço de
comunicação (modelo 21). Valores permitidos: 5301: Prestação de serviço de
comunicação para execução de serviço da mesma natureza; 5302: Prestação de
serviço de comunicação a estabelecimento industrial; 5303: Prestação de serviço
de comunicação a estabelecimento comercial; 5304: Prestação de serviço de
comunicação a estabelecimento de prestador de serviço de transporte; 5305:
Prestação de serviço de comunicação a estabelecimento de geradora ou de
distribuidora de energia elétrica; 5306: Prestação de serviço de comunicação a
estabelecimento de produtor rural; 5307: Prestação de serviço de comunicação a
não contribuinte; 6301: Prestação de serviço de comunicação para execução de
serviço da mesma natureza; 6302: Prestação de serviço de comunicação a
estabelecimento industrial; 6303: Prestação de serviço de comunicação a
estabelecimento comercial; 6304: Prestação de serviço de comunicação a
estabelecimento de prestador de serviço de transporte; 6305: Prestação de
serviço de comunicação a estabelecimento de geradora ou de distribuidora de
energia elétrica; 6306: Prestação de serviço de comunicação a estabelecimento de
produtor rural; 6307: Prestação de serviço de comunicação a não contribuinte.
B25 DiaVencimento Não B01 Número Dia de vencimento do faturamento do cliente.
Informar um valor no intervalo de 0 a 31. São aceitos apenas dias de vencimento
existentes nos ciclos de faturamento cadastrados no RBX. B26 DiasProtesto Não
B01 Número Dias para protesto automático do cliente em caso de inadimplência.
B27 DebitoAgencia Não B01 Número Número da agência (com DV) do cliente para as
operações de débito em conta. B28 DebitoOperacao Não B01 Número Número da
operação da conta do cliente para as operações de débito em conta nas cobranças
do banco 104-Caixa Econômica Federal. Valores permitidos: 001: Conta Corrente
Pessoa Física; 003: Conta Corrente Pessoa Jurídica; 013: Conta Poupança Pessoa
Física. B29 DebitoConta Não B01 Número Número da conta corrente (com DV) do
cliente para a operação de débito em conta. B30 Sigla Não B01 Texto Apelido para
pessoa física ou nome fantasia para pessoa jurídica. B31 CobrEndereco Não B01
Texto Endereço de cobrança. B32 CobrEndNumero Não B01 Número Número do endereço
de cobrança. B33 CobrComplemento Não B01 Texto Complemento do endereço de
cobrança. B34 CobrBairro Não B01 Texto Bairro do endereço de cobrança. B35
CobrCidade Não B01 Texto Nome do município do endereço de cobrança. B36 CobrUF
Não B01 Texto UF do endereço de cobrança. B37 CobrCEP Não B01 Número CEP do
endereço de cobrança. B38 Bloqueavel Não B01 Texto Bloqueável. Valores
permitidos: S: Indica que o cliente pode ser bloqueado automaticamente; N:
Indica que o cliente não pode ser bloqueado automaticamente. B39 Negativavel Não
B01 Texto Negativável. Valores permitidos: S: Indica que o cliente pode ser
negativado automaticamente; N: Indica que o cliente não pode ser negativado
automaticamente;
Para utilizar este campo é necessário o módulo do SPC Brasil. B40 AvisoPagamento
Não B01 Texto Aviso de pagamento. Valores permitidos: S: Indica que o cliente
pode comunicar um aviso de pagamento; A: Indica que o cliente pode comunicar um
aviso de pagamento, mas já está em um nível de alerta; N: Indica que o cliente
não pode comunicar um aviso de pagamento. B41 CobrGrupo Não B01 Número Informar
o código de um dos grupos de cobrança cadastrados no RBX. B42 Email Não B01
Texto E-mail principal do cliente. B43 EnviarBoletoEmail Não B01 Texto Informar
S para indicar que o faturamento (boleto/nota fiscal) deverá ser enviado para o
e-mail do cliente. B44 Observacoes Não B01 Texto Observações do cliente. B45
BuscarCoordenadas Não B01 Texto Buscar coordenadas, onde S indica que no momento
do cadastro, o sistema deverá buscar as coordenadas do endereço do cliente
(latitude/longitude). Esta consulta é realizada através da API do Google Maps.
Caso a integração com o Google Maps esteja desativada, a busca não será
realizada. B46 Latitude Não B01 Decimal(16.13) Latitude do endereço do cliente.
B47 Longitude Não B01 Decimal(16.13) Longitude do endereço do cliente. B48
Servidor Não B01 Número Informar um dos servidores com serviço Gateway
cadastrados no RBX. B49 Grupo Não B01 Número Informar o código de um dos grupos
cadastrados no RBX. B50 TipoAssinante2 Não B01 Número Código necessário para
geração do arquivo fiscal referentes às notas modelos 21 e 22. Valores
permitidos: 01: Comercial; 02: Industrial; 03: Residencial/Pessoa Física; 04:
Produtor Rural; 05: Órgão da administração pública estadual direta e suas
fundações e autarquias, quando mantidas pelo poder público estadual e regidas
por normas de direito público, nos termos do Convênio ICMS 107/95; 06: Prestador
de serviço de telecomunicação responsável pelo recolhimento do imposto incidente
sobre a cessão dos meios de rede do prestador do serviço ao usuário final, nos
termos do Convênio ICMS 17/13; 07: Missões Diplomáticas, Repartições Consulares
e Organismos Internacionais, nos termos do Convênio ICMS 158/94; 08: Igrejas e
Templos de qualquer natureza; 99: Outros não especificados anteriormente.
Se este campo não for informado, o cliente será cadastrado automaticamente com o
tipo 01 se for pessoa jurídica ou com o tipo 03 se for pessoa física; B51
ContribuinteICMS Não B01 Número Código necessário para geração da NF-e.Valores
permitidos: 1: Contribuinte ICMS; 2: Contribuinte ISENTO; 9: Não Contribuinte.
Se este campo não for informado, o cliente será cadastrado automaticamente com o
tipo 1 se possuir Inscrição Estadual ou com o tipo 2 caso não possua. B52
TipoConta Sim B01 Texto Define do tipo de conta do cliente. Valores permitidos:
PRE: Pré-pago; POS: Pós-pago. B53 DadosAdicionais Não B01 - Grupo de informação
dos dados adicionais do cliente C01 DadoAdicional Não B53 - Grupo de informação
dos dados adicionais do cliente. C02 Codigo Não C01 Número Informar o código de
um dado adicional cadastrado no RBX. C03 Conteudo Não C01 - Informar o conteúdo
do dado adicional respeitando as regras existentes para o mesmo, conforme
cadastrado no RBX. D01 Contatos Não B01 - Grupo de informação dos contatos do
cliente. E01 Contato Não D01 - Grupo de informação dos contatos do cliente. F01
Nome Sim E01 Texto Nome do contato. F02 Tipo Sim E01 Texto Tipo do contato.
Valores permitidos: G: Geral; A: Administrativo; T: Técnico. F03 Complemento Não
E01 Número Informar o código de um complemento cadastrado no RBX. F04 Email Não
E01 Texto E-mail do contato. F05 Telefone1 Não E01 Número Primeiro telefone do
contato. F06 Telefone2 Não E01 Número Segundo telefone do contato. F07 Telefone3
Não E01 Número Terceiro telefone do contato. F08 Aniversario Não E01 Data Data
de nascimento do contato. F09 Situacao Não E01 Texto Situação do contato.
Valores permitidos: A: Ativo; I: Inativo.
CADASTRO DE MERCADOS
O objetivo deste serviço é realizar o cadastro de um novo mercado no RBX.
> Request Example:
Copy to Clipboard{
"MercadoCadastro": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"DadosMercado": {
"TipoPessoa": "F",
"CPF": "607.942.320-00",
"Nome": "João da Silva",
"Endereco": "Rua Presidente Nereu Ramos",
"EndNumero": "1001",
"Bairro": "Centro",
"CodMunicipio": "4114807",
"UF": "PR",
"CEP": "86990000",
"TipoImpressao": "C",
"Email": "joao.silva@provedor.com",
"TipoAssinante": "3",
"TipoConta": "POS",
"DadosAdicionais": {
"DadoAdicional": {
"Codigo": "2",
"Valor": "300"
}
},
"Contatos": {
"Contato": [
{
"Nome": "Maria da Silva",
"Tipo": "G",
"Email": "maria.silva@provedor.com"
},
{
"Nome": "Carlos da Silva",
"Tipo": "G",
"Email": "carlos.silva@provedor.com"
}
]
}
}
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": {
"CodigoMercado": "484",
"Mensagem": "Mercado cadastrado com sucesso"
}
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "Campo obrigatorio nao informado",
"erro_detail": "TipoPessoa",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 MercadoCadastro Sim Raiz - Nome do
serviço. B01 DadosMercado Sim A01 - Dados do mercado. B02 TipoPessoa Sim B01
Texto Tipo de pessoa. Valores permitidos: P: Pessoa Física; J: Pessoa Jurídica.
B03 CPF Sim* B01 Texto CPF do mercado. Este campo é obrigatório se no campo B02
foi informado o valor P. B03 CNPJ Sim* B01 Texto CNPJ do mercado. Este campo é
obrigatório se no campo B02 foi informado o valor J. B04 Nome Sim B01 Texto Nome
do mercado. B05 Endereco Não B01 Texto Endereço do mercado. B06 EndNumero Não
B01 Número Número do endereço. B07 Complemento Não B01 Texto Complemento do
endereço. B08 Bairro Não B01 Texto Bairro do endereço. B09 CodMunicipio Sim B01
Número Código do município do mercado de acordo com a tabela de municípios do
IBGE. B10 Distrito Não B01 Texto Nome do distrito B11 UF Sim B01 Texto UF do
endereço. B12 CEP Não B01 Número CEP do endereço. B13 TelComercial Não B01
Número Número do telefone comercial. B14 TelResidencial Não B01 Número Número do
telefone residencial. B15 TelCelular Não B01 Número Número do telefone celular.
B16 Banco Não B01 Número Local de cobrança padrão do mercado. Informar o código
de um dos bancos cadastrados no RBX. B17 RG Não B01 Texto RG. Este campo só deve
ser informado se no campo B02 foi informado o valor P. B17 IE Não B01 Texto
Inscrição Estadual. Este campo só deve ser informado se no campo B02 foi
informado o valor J. B18 Nascimento Não B01 Data Data de nascimento para pessoa
física ou data de criação para pessoa jurídica. B19 CodCobr Não B01 Texto Código
de cobrança do mercado junto ao banco, quando houver. B20 Cobranca Não B01 Texto
Tipo de cobrança. Valores permitidos: S: Cobrança Simples; R: Cobrança
Registrada; D: Débito em Conta; C: Cartão de Crédito. B21 TipoImpressao Não B01
Texto Tipo de impressão. Valores permitidos: B: Boleto; C: Carnê. B22 Convenio
Não B01 Número Código do convênio bancário cadastrado para o banco informado no
campo B16. B23 TipoAssinante Não B01 Número Tipo de assinante. Valores
permitidos: 1: Comercial/Industrial; 2: Poder Público; 3: Residencial/Pessoa
Física; 4: Público; 5: Semi-Público; 6: Outros.
Se este campo não for informado, o mercado será cadastrado automaticamente com o
tipo 1 se for pessoa jurídica ou com o tipo 3 se for pessoa física. B24 CFOP Não
B01 Número CFOP específico para emissão de notas fiscais de serviço de
comunicação (modelo 21). Valores permitidos: 5301: Prestação de serviço de
comunicação para execução de serviço da mesma natureza; 5302: Prestação de
serviço de comunicação a estabelecimento industrial; 5303: Prestação de serviço
de comunicação a estabelecimento comercial; 5304: Prestação de serviço de
comunicação a estabelecimento de prestador de serviço de transporte; 5305:
Prestação de serviço de comunicação a estabelecimento de geradora ou de
distribuidora de energia elétrica; 5306: Prestação de serviço de comunicação a
estabelecimento de produtor rural; 5307: Prestação de serviço de comunicação a
não contribuinte; 6301: Prestação de serviço de comunicação para execução de
serviço da mesma natureza; 6302: Prestação de serviço de comunicação a
estabelecimento industrial; 6303: Prestação de serviço de comunicação a
estabelecimento comercial; 6304: Prestação de serviço de comunicação a
estabelecimento de prestador de serviço de transporte; 6305: Prestação de
serviço de comunicação a estabelecimento de geradora ou de distribuidora de
energia elétrica; 6306: Prestação de serviço de comunicação a estabelecimento de
produtor rural; 6307: Prestação de serviço de comunicação a não contribuinte.
B25 DiaVencimento Não B01 Número Dia de vencimento do faturamento do mercado.
Informar um valor no intervalo de 0 a 31. São aceitos apenas dias de vencimento
existentes nos ciclos de faturamento cadastrados no RBX. B26 DiasProtesto Não
B01 Número Dias para protesto automático do mercado em caso de inadimplência.
B27 DebitoAgencia Não B01 Número Número da agência (com DV) do mercado para as
operações de débito em conta. B28 DebitoOperacao Não B01 Número Número da
operação da conta do mercado para as operações de débito em conta nas cobranças
do banco 104-Caixa Econômica Federal. Valores permitidos: 001: Conta Corrente
Pessoa Física; 003: Conta Corrente Pessoa Jurídica; 013: Conta Poupança Pessoa
Física. B29 DebitoConta Não B01 Número Número da conta corrente (com DV) do
mercado para a operação de débito em conta. B30 Sigla Não B01 Texto Apelido para
pessoa física ou nome fantasia para pessoa jurídica. B31 CobrEndereco Não B01
Texto Endereço de cobrança. B32 CobrEndNumero Não B01 Número Número do endereço
de cobrança. B33 CobrComplemento Não B01 Texto Complemento do endereço de
cobrança. B34 CobrBairro Não B01 Texto Bairro do endereço de cobrança. B35
CobrCidade Não B01 Texto Nome do município do endereço de cobrança. B36 CobrUF
Não B01 Texto UF do endereço de cobrança. B37 CobrCEP Não B01 Número CEP do
endereço de cobrança B38 Bloqueavel Não B01 Texto Bloqueável. Valores
permitidos: S: Indica que o mercado pode ser bloqueado automaticamente; N:
Indica que o mercado não pode ser bloqueado automaticamente. B39 Negativavel Não
B01 Texto Negativável. Valores permitidos: S: Indica que o mercado pode ser
negativado automaticamente; N: Indica que o mercado não pode ser negativado
automaticamente;
Para utilizar este campo é necessário o módulo do SPC Brasil. B40 AvisoPagamento
Não B01 Texto Aviso de pagamento. Valores permitidos: S: Indica que o mercado
pode comunicar um aviso de pagamento; A: Indica que o mercado pode comunicar um
aviso de pagamento, mas já está em um nível de alerta; N: Indica que o mercado
não pode comunicar um aviso de pagamento. B41 CobrGrupo Não B01 Número Informar
o código de um dos grupos de cobrança cadastrados no RBX. B42 Email Não B01
Texto E-mail principal do mercado. B43 EnviarBoletoEmail Não B01 Texto Informar
S para indicar que o faturamento (boleto/nota fiscal) deverá ser enviado para o
e-mail do mercado. B44 Observacoes Não B01 Texto Observações do mercado. B45
BuscarCoordenadas Não B01 Texto Buscar coordenadas, onde S indica que no momento
do cadastro, o sistema deverá buscar as coordenadas do endereço do mercado
(latitude/longitude). Esta consulta é realizada através da API do Google Maps.
Caso a integração com o Google Maps esteja desativada, a busca não será
realizada. B46 Latitude Não B01 Decimal(16.13) Latitude do endereço do mercado.
B47 Longitude Não B01 Decimal(16.13) Longitude do endereço do mercado. B48
Servidor Não B01 Número Informar um dos servidores com serviço Gateway
cadastrados no RBX. B49 Grupo Não B01 Número Informar o código de um dos grupos
cadastrados no RBX. B50 TipoAssinante2 Não B01 Número Código necessário para
geração do arquivo fiscal referentes às notas modelos 21 e 22. Valores
permitidos: 01: Comercial; 02: Industrial; 03: Residencial/Pessoa Física; 04:
Produtor Rural; 05: Órgão da administração pública estadual direta e suas
fundações e autarquias, quando mantidas pelo poder público estadual e regidas
por normas de direito público, nos termos do Convênio ICMS 107/95; 06: Prestador
de serviço de telecomunicação responsável pelo recolhimento do imposto incidente
sobre a cessão dos meios de rede do prestador do serviço ao usuário final, nos
termos do Convênio ICMS 17/13; 07: Missões Diplomáticas, Repartições Consulares
e Organismos Internacionais, nos termos do Convênio ICMS 158/94; 08: Igrejas e
Templos de qualquer natureza; 99: Outros não especificados anteriormente.
Se este campo não for informado, o mercado será cadastrado automaticamente com o
tipo 01 se for pessoa jurídica ou com o tipo 03 se for pessoa física; B51
ContribuinteICMS Não B01 Número Código necessário para geração da NF-e.Valores
permitidos: 1: Contribuinte ICMS; 2: Contribuinte ISENTO; 9: Não Contribuinte.
Se este campo não for informado, o mercado será cadastrado automaticamente com o
tipo 1 se possuir Inscrição Estadual ou com o tipo 2 caso não possua. B52
TipoConta Sim B01 Texto Define do tipo de conta do mercado. Valores permitidos:
PRE: Pré-pago; POS: Pós-pago. B53 DadosAdicionais Não B01 - Grupo de informação
dos dados adicionais do mercado C01 DadoAdicional Não B53 - Grupo de informação
dos dados adicionais do mercado. C02 Codigo Não C01 Número Informar o código de
um dado adicional cadastrado no RBX. C03 Conteudo Não C01 - Informar o conteúdo
do dado adicional respeitando as regras existentes para o mesmo, conforme
cadastrado no RBX. D01 Contatos Não B01 - Grupo de informação dos contatos do
mercado. E01 Contato Não D01 - Grupo de informação dos contatos do mercado. E02
Nome Sim E01 Texto Nome do contato. E03 Tipo Sim E01 Texto Tipo do contato.
Valores permitidos: G: Geral; A: Administrativo; T: Técnico. E04 Complemento Não
E01 Número Informar o código de um complemento cadastrado no RBX. E05 Email Não
E01 Texto E-mail do contato. E06 Telefone1 Não E01 Número Primeiro telefone do
contato. E07 Telefone2 Não E01 Número Segundo telefone do contato. E08 Telefone3
Não E01 Número Terceiro telefone do contato. E09 Aniversario Não E01 Data Data
de nascimento do contato. E10 Situacao Não E01 Texto Situação do contato.
Valores permitidos: A: Ativo; I: Inativo.
CONSULTA CLIENTES
O objetivo deste serviço é retornar uma lista com os principais dados dos
clientes cadastrados no RBX.
> Request Example:
Copy to Clipboard{
"ConsultaClientes": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Codigo = '1'"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Codigo": "1",
"Tipo": "F",
"CNPJ_CNPF": "71672194016",
"Nome": "Cliente 01",
"Endereco": "Rua Presidente Nereu Ramos",
"Numero": "1001",
"Complemento": "",
"Bairro": "Centro",
"Cidade": "Marialva",
"Distrito": "",
"UF": "PR",
"CEP": "86990000",
"TelComercial": "4432323232",
"TelResidencial": "",
"TelCelular": "44999998888",
"BcoCobr": "9",
"RG_IE": "",
"Nascimento": "1990-01-01",
"CodCobr": "",
"Cobranca": "R",
"TipoImpressao": "C",
"DiaCobr": "0",
"DiasProtesto": "0",
"Sigla": "",
"Cobr_Endereco": "",
"Cobr_Complemento": "",
"Cobr_Bairro": "",
"Cobr_Cidade": "",
"Cobr_UF": "",
"Cobr_CEP": "",
"Bloqueavel": "N",
"Inclusao": "2023-12-01",
"usuario": "joao.silva",
"Observacoes": "Casa Azul.",
"MapsMarkLat": "",
"MapsMarkLng": "",
"Grupo": "3",
"Situacao": "A",
"Email": "cliente01@email.com",
"AvisoPagamento": "N"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaClientes Sim Raiz - Nome
do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Codigo Número Código do cliente. Tipo Texto Tipo de
pessoa:F: Pessoa Física; J: Pessoa Jurídica. CNPJ_CNPF Número CPF para pessoa
física ou CNPJ para pessoa jurídica. Nome Texto Nome do cliente. Endereco Texto
Endereço do cliente. Numero Número Número do endereço. Complemento Texto
Complemento do endereço. Bairro Texto Bairro do endereço. Cidade Texto Cidade do
endereço. Distrito Texto Nome do distrito. UF Texto UF do endereço. CEP Número
CEP do endereço. TelComercial Número Telefone comercial. TelResidencial Número
Telefone residencial. TelCelular Número Telefone celular. BcoCobr Número Local
de cobrança padrão do cliente (Código de um dos bancos cadastrados no RBX).
RG_IE Número Registro Geral ou Inscrição Estadual. Nascimento Data Data de
nascimento do cliente. CodCobr Número Código de cobrança do cliente junto ao
banco. Cobranca Texto Tipo de cobrança: S: Cobrança Simples; R: Cobrança
Registrada; D: Débito em Conta; C: Cartão de Crédito. TipoImpressao Texto Tipo
de impressão: B: Boleto; C: Carnê. DiaCobr Número Dia de vencimento do cliente.
DiasProtesto Número Dias para protesto automático do cliente em caso de
inadimplência. Sigla Texto Apelido para pessoa física ou nome fantasia para
pessoa jurídica. Cobr_Endereco Texto Endereço de cobrança. Cobr_Complemento
Texto Complemento do endereço de cobrança. Cobr_Bairro Texto Bairro do endereço
de cobrança. Cobr_Cidade Texto Nome do município do endereço de cobrança.
Cobr_UF Texto UF do endereço de cobrança. Cobr_CEP Número CEP do endereço de
cobrança. Bloqueavel Texto Bloqueável: S: Cliente é bloqueado automaticamente em
caso de inadimplência; N: Cliente não é bloqueado automaticamente em caso de
inadimplência. Inclusao Data Data de cadastro do cliente. usuario Texto Usuário
de cadastro do cliente. Observacoes Texto Texto livre. MapsMarkLat
Decimal(16.13) Latitude do cliente. MapsMarkLng Decimal(16.13) Longitude do
cliente. Grupo Número Código do grupo do cliente. Situacao Texto Situação do
cliente: A: Ativo; I: Inativo; B: Bloqueado; S: Suspenso; C: Cancelado; I: Em
Instalação; E: Aguardando Instalação. Email Texto E-mail do cliente.
AvisoPagamento Texto Aviso de pagamento: S: Indica que o cliente pode comunicar
um aviso de pagamento; A: Indica que o cliente pode comunicar um aviso de
pagamento, mas já está em um nível de alerta; N: Indica que o cliente não pode
comunicar um aviso de pagamento.
CONSULTA CLIENTES BLOQUEADOS
O objetivo deste serviço é retornar uma lista com todos os clientes bloqueados.
> Request Example:
Copy to Clipboard{
"ConsultaClientesBloqueados": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Nome = 'João da Silva'"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Codigo": "330593",
"Nome": "João da Silva",
"DataBloqueio": "2023-09-28 08:32:56",
"DiasBloqueio": "68"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaClientesBloqueados Sim
Raiz - Nome do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Codigo Número Código do cliente. Nome Texto Nome do
cliente. DataBloqueio Data/Hora Data e hora do bloqueio. DiasBloqueio Número
Quantidade de dias que o cliente foi bloqueado.
CONSULTA CLIENTES COM REDUÇÃO DE BANDA
O objetivo deste serviço é retornar uma lista com os clientes que estão
enquadrados em uma regra de redução de banda do Cobrador Virtual.
> Request Example:
Copy to Clipboard{
"ConsultaClientesReducao": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Cliente_Codigo = 1"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Regra": "3",
"Cliente_Codigo": "1",
"Cliente_Nome": "João da Silva",
"Contrato_Numero": "123",
"Contrato_Descricao": "Plano 500 MB"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaClientesReducao Sim Raiz -
Nome do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Regra Número Número da regra na qual o cliente está
enquadrado. Cliente_Codigo Número Código do cliente. Cliente_Nome Texto Nome do
cliente. Contrato_Numero Número Número do contrato. Contrato_Descricao Texto
Descrição do plano do contrato.
CONSULTA CLIENTES ON-LINE
O objetivo deste serviço é retornar uma lista com os clientes e a indicação se o
mesmo está on-line no RBX.
> Request Example:
Copy to Clipboard{
"ConsultaClienteOnline": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Codigo = '1'"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Codigo": "1",
"Nome": "João da Silva",
"Online": "N",
"NasConectados": ""
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaClienteOnline Sim Raiz -
Nome do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Codigo Número Código do cliente. Nome Texto Nome do
cliente. Online Texto Indica se o cliente está on-line ou off-line: S: On-line;
N: Off-line.
O sistema considera um cliente on-line quando o mesmo possui pelo menos uma
autenticação on-line. NasConectados Texto Lista de IPs dos NAS (separados por
vírgula) nos quais o cliente está conectado.
CONSULTA COMPLEMENTOS DE CONTATOS
O objetivo deste serviço é retornar uma lista com os complementos de contatos
cadastrados no RBX. Atenção: este serviço não possui suporte a filtros.
> Request Example:
Copy to Clipboard{
"ConsultaComplementoContatos": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
}
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Codigo": "1",
"Tipo": "F",
"Nome": "Filho(a)"
},
{
"Codigo": "2",
"Tipo": "J",
"Nome": "Gerente"
},
{
"Codigo": "3",
"Tipo": "F",
"Nome": "Esposo(a)"
},
{
"Codigo": "4",
"Tipo": "F",
"Nome": "Mãe"
},
{
"Codigo": "5",
"Tipo": "F",
"Nome": "Pai"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 97,
"erro_inf": "",
"erro_desc": "Erro de integracao",
"erro_detail": "Chave de integracao invalida ou inativa",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaComplementoContatos Sim
Raiz - Nome do serviço.
CAMPOS DO RETORNO
Campo Tipo Observações Codigo Número Código do complemento. Tipo Texto Tipo de
pessoa: F: Pessoa Física; J: Pessoa Jurídica. Nome Texto Nome do complemento.
CONSULTA CONTATOS
O objetivo deste serviço é retornar uma lista com os contatos cadastrados.
> Request Example:
Copy to Clipboard{
"ConsultaContatos": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Cliente = 1"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Id": "1",
"Nome": "Contato Primário",
"CPF": "",
"Email": "",
"Telefone1": "44999999999",
"Telefone2": "",
"Telefone3": "",
"Aniversario": "",
"Tipo": "G",
"Situacao": "A",
"Cliente": "1"
},
{
"Id": "13",
"Nome": "Contato Secundário",
"CPF": "",
"Email": "",
"Telefone1": "44988888888",
"Telefone2": "",
"Telefone3": "",
"Aniversario": "",
"Tipo": "A",
"Situacao": "A",
"Cliente": "1"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaContatos Sim Raiz - Nome
do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações id Número Código do contato (No filtro, utilizar o valor
Cliente). Nome Texto Nome do contato. CPF Número CPF vinculado ao contato. Email
Texto E-mail do contato. Telefone1 Número Telefone 1 do contato (apenas
números). Telefone2 Número Telefone 2 do contato (apenas números). Telefone3
Número Telefone 3 do contato (apenas números). Aniversario Número Data de
aniversário no formato DDAAAA. Tipo Texto Tipo do contato: G: Geral; A:
Administrativo; T: Técnico. Situacao Texto Situação do contato: A: Ativo; I:
Inativo. Cliente Número Código do cliente ao qual o contato está vinculado.
CONSULTA DADOS ADICIONAIS DE CLIENTES, CONTRATOS E ATENDIMENTOS
O objetivo deste serviço é retornar uma lista com os dados adicionais de
clientes, contratos e atendimentos.
> Request Example:
Copy to Clipboard{
"ConsultarDadosAdicionais": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Tabela = 'Clientes' AND Chave = 9"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Id": "27",
"Codigo": "1",
"Descricao": "Clientes_Filial",
"Tabela": "Clientes",
"Chave": "9",
"Valor": "201"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultarDadosAdicionais Sim Raiz
- Nome do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Id Número Id do dado adicional. Codigo Número Código do
dado adicional. Descricao Texto Nome do dado adicional. Tabela Texto Tabela na
qual o dado adicional pertence. Chave Texto Id do cliente, contrato ou
atendimento. Valor Texto Valor do dado adicional.
CONSULTA DADOS DE COBRANÇA DE CLIENTES
O objetivo deste serviço é retornar uma lista com os dados de cobrança dos
clientes cadastrados no RBX.
> Request Example:
Copy to Clipboard{
"ConsultaClientesCobranca": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Nome = 'João da Silva'"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Codigo": "123",
"Nome": "João da Silva",
"BcoCobr": "748",
"CodCobr": "",
"Cobranca": "R",
"TipoImpressao": "C",
"DiaCobr": "10",
"DiasProtesto": "0",
"Cobr_Endereco": "",
"Cobr_Complemento": "",
"Cobr_Bairro": "",
"Cobr_Cidade": "",
"Cobr_UF": "",
"Cobr_CEP": "",
"Bloqueavel": "N"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaClientesCobranca Sim Raiz
- Nome do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Codigo Número Código do cliente. Nome Texto Nome do
cliente. BcoCobr Número Local de cobrança padrão do cliente (Código de um dos
bancos cadastrados no RBX). CodCobr Texto Código de cobrança do cliente junto ao
banco. Cobranca Texto Tipo de cobrança: S: Cobrança Simples; R: Cobrança
Registrada; D: Débito em Conta; C: Cartão de Crédito. TipoImpressao Texto Tipo
de impressão: B: Boleto; C: Carnê. DiaCobr Número Dia de vencimento do cliente.
DiasProtesto Número Dias para protesto automático do cliente em caso de
inadimplência. Cobr_Endereco Texto Endereço de cobrança. Cobr_Complemento Texto
Complemento do endereço de cobrança. Cobr_Bairro Texto Bairro do endereço de
cobrança. Cobr_Cidade Texto Nome do município do endereço de cobrança. Cobr_UF
Texto UF do endereço de cobrança. Cobr_CEP Número CEP do endereço de cobrança.
Bloqueavel Texto Bloqueável: S: Cliente é bloqueado automaticamente em caso de
inadimplência; N: Cliente não é bloqueado automaticamente em caso de
inadimplência.
CONSULTA EQUIPAMENTOS ON-LINE
O objetivo deste serviço é retornar uma lista com os equipamentos on-line dos
clientes.
> Request Example:
Copy to Clipboard{
"ConsultaEquipamentosOnline": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Cliente_Codigo = '1'"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Cliente_Codigo": "1",
"Cliente_Nome": "João da Silva",
"Contrato_Numero": "123",
"Contrato_Descricao": "PLANO 500 MB",
"DataHora_UltimaColeta": "2024-01-20 12:00:00",
"NAS_IP": "100.0.0.10",
"NAS_Sigla": "NAS_PRINCIPAL",
"NAS_Descricao": "NAS_PRINCIPAL",
"NAS_Slot": "3",
"NAS_Porta": "5",
"Equipamento_Id": "1382",
"Equipamento_Descricao": "COMPLEMENTO",
"Equipamento_Serial": "1234567",
"Equipamento_Sinal": "-29.00",
"Equipamento_Txccq": "0",
"Equipamento_MaxCpe": "0",
"Equipamento_Temperatura": "46",
"Equipamento_TempoConectadoMinutos": "10"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaEquipamentosOnline Sim
Raiz - Nome do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Cliente_Codigo Número Código do cliente. Cliente_Nome
Texto Nome do cliente. Contrato_Numero Número Número do contrato.
Contrato_Descricao Texto Descrição do plano. DataHora_UltimaColeta Data/Hora
Data e hora da última coleta. NAS_IP Texto IP do NAS. NAS_Sigla Texto Sigla do
NAS. NAS_Descricao Texto Descrição do NAS. NAS_Slot Texto Slot do NAS. NAS_Porta
Texto Porta do NAS. Equipamento_Id Número Código interno do equipamento.
Equipamento_Descricao Texto Descrição do equipamento. Equipamento_Serial Texto
Serial do equipamento. Equipamento_Sinal Número Sinal do equipamento.
Equipamento_Txccq Número TX-ccq do equipamento. Equipamento_MaxCpe Número MACs
CPE do equipamento. Equipamento_Temperatura Número Temperatura do equipamento.
Equipamento_TempoConectadoMinutos Hora Tempo de conexão do equipamento em
minutos.
CONSULTA GRUPOS DE CLIENTES
O objetivo deste serviço é retornar uma lista com os grupos de clientes
cadastrados no RBX. Atenção: este serviço não possui suporte a filtros.
> Request Example:
Copy to Clipboard{
"ConsultaGruposCliente": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
}
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Codigo": "1",
"Nome": "Grupo Residencial"
},
{
"Codigo": "2",
"Nome": "Grupo Corporativo"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 97,
"erro_inf": "",
"erro_desc": "Erro de integracao",
"erro_detail": "Chave de integracao invalida ou inativa",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaGruposCliente Sim Raiz -
Nome do serviço.
CAMPOS DO RETORNO
Campo Tipo Observações Codigo Número Código do grupo. Nome Texto Nome do grupo.
CONSULTA MERCADOS
O objetivo deste serviço é retornar uma lista com os principais dados dos
mercados cadastrados no RBX.
> Request Example:
Copy to Clipboard{
"ConsultaMercados": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Codigo = 1"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Codigo": "1",
"Tipo": "F",
"CNPJ_CNPF": "43376452091",
"Nome": "João da Silva",
"Endereco": "",
"Numero": "0",
"Complemento": "",
"Bairro": "",
"Cidade": "Marialva",
"Distrito": "",
"UF": "PR",
"CEP": "",
"TelComercial": "",
"TelResidencial": "",
"TelCelular": "4499999999",
"BcoCobr": "748",
"RG_IE": "",
"Nascimento": "",
"CodCobr": "",
"Cobranca": "R",
"TipoImpressao": "B",
"DiaCobr": "0",
"DiasProtesto": "0",
"Sigla": "",
"Cobr_Endereco": "",
"Cobr_Complemento": "",
"Cobr_Bairro": "",
"Cobr_Cidade": "",
"Cobr_UF": "",
"Cobr_CEP": "",
"Bloqueavel": "N",
"Inclusao": "2024-01-20",
"usuario": "joao.silva",
"Observacoes": "",
"MapsMarkLat": "0.0000000000000",
"MapsMarkLng": "0.0000000000000",
"Grupo": "0"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaMercados Sim Raiz - Nome
do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Codigo Número Código do mercado. Tipo Texto Tipo de
pessoa: F: Pessoa física; J: Pessoa jurídica. CNPJ_CNPF Número CPF para pessoa
física ou CNPJ para pessoa jurídica. Nome Texto Nome do mercado. Endereco Texto
Endereço. Numero Número Número do endereço. Complemento Texto Complemento do
endereço. Bairro Texto Bairro do endereço. Cidade Texto Cidade do endereço.
Distrito Texto Nome do distrito. UF Texto UF do endereço. CEP Número CEP do
endereço. TelComercial Número Telefone comercial. TelResidencial Número Telefone
residencial. TelCelular Número Telefone celular. BcoCobr Número Local de
cobrança padrão do mercado (Código de um dos bancos cadastrados no RBX). RG_IE
Texto RG para pessoa física e IE para pessoa jurídica. Nascimento Data Data de
nascimento. CodCobr Texto Código de cobrança para cobranças registradas ou
débito em conta. Cobranca Texto Tipo de cobrança: S: Cobrança Simples; R:
Cobrança Registrada; D: Débito em Conta; C: Cartão de Crédito. TipoImpressao
Texto Tipo de impressão: B: Boleto; C: Carnê. DiaCobr Número Dia de vencimento.
DiasProtesto Número Dias para protesto automático do mercado em caso de
inadimplência. Sigla Texto Apelido para pessoa física ou nome fantasia para
pessoa jurídica. Cobr_Endereco Texto Endereço de cobrança. Cobr_Complemento
Texto Complemento do endereço de cobrança. Cobr_Bairro Texto Bairro do endereço
de cobrança. Cobr_Cidade Texto Nome do município do endereço de cobrança.
Cobr_UF Texto UF do endereço de cobrança. Cobr_CEP Número CEP do endereço de
cobrança. Bloqueavel Texto Bloqueável: S: Sim; N: Não. Inclusao Data Data de
cadastro. usuario Texto Usuário de cadastro. Observacoes Texto Observações do
mercado. MapsMarkLat Decimal(16.13) Latitude referente ao endereço principal.
MapsMarkLng Decimal(16.13) Longitude referente ao endereço principal. Grupo
Número Código do grupo do mercado.
CONTRATOS
CONSULTA CONCORRÊNCIA
O objetivo deste serviço é retornar uma lista com os concorrentes cadastrados no
RBX. Atenção: este serviço não possui suporte a filtros.
> Request Example:
Copy to Clipboard{
"ConsultaConcorrencia": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
}
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"id": "1",
"Nome": "VIVO"
},
{
"id": "2",
"Nome": "Claro"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 97,
"erro_inf": "",
"erro_desc": "Erro de integracao",
"erro_detail": "Chave de integracao invalida ou inativa",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaConcorrencia Sim Raiz -
Nome do serviço.
CAMPOS DO RETORNO
Campo Tipo Observações id Número Código do concorrente. Nome Texto Nome do
concorrente.
CONSULTA CONTRATOS
O objetivo deste serviço é retornar uma lista com os contratos cadastrados no
RBX.
> Request Example:
Copy to Clipboard{
"ConsultaContratos": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Plano_Codigo = '1'"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Cliente_Codigo": "1",
"Cliente_Nome": "João da Silva",
"Numero": "292",
"Plano_Codigo": "1",
"Plano_Descricao": "Plano 200 MB",
"Pacote_Codigo": "0",
"Pacote_Descricao": "",
"Pacote_PacoteID": "",
"Situacao_Codigo": "A",
"Situacao_Descricao": "Ativo",
"Modelos_Contrato": "",
"Assinatura": "2023-01-24",
"Inicio": "2023-05-12",
"DataUltimaOperacao": "",
"CicloFaturamento_DiaBase": "1",
"CicloFaturamento_Vencimento": "10",
"ValorBruto": "25.00",
"DescontoFixo": "0.00",
"ValorLiquido": "25.00",
"DescontoPromocional_Valor": "0.00",
"DescontoPromocional_Prazo": "0",
"Vigencia": "0",
"Agrupamento": "Nao",
"Assinado": "Nao",
"EnderecoCobranca_Logradouro": "",
"EnderecoCobranca_Numero": "",
"EnderecoCobranca_Complemento": "",
"EnderecoCobranca_Bairro": "",
"EnderecoCobranca_Cidade": "",
"EnderecoCobranca_UF": "",
"EnderecoCobranca_CEP": "",
"EnderecoCobranca_Pais": "",
"EnderecoCobranca_LocalidadeId": "",
"EnderecoCobranca_BairroId": "",
"EnderecoCobranca_LogradouroId": "",
"EnderecoCobranca_GoogleMapsPlaceId": "",
"EnderecoCobranca_Latitude": "",
"EnderecoCobranca_Longitude": "",
"EnderecoInstalacao_UsadoParaCobranca": "",
"EnderecoInstalacao_Logradouro": "",
"EnderecoInstalacao_Numero": "",
"EnderecoInstalacao_Complemento": "",
"EnderecoInstalacao_Bairro": "",
"EnderecoInstalacao_Cidade": "",
"EnderecoInstalacao_UF": "",
"EnderecoInstalacao_CEP": "",
"EnderecoInstalacao_Pais": "",
"EnderecoInstalacao_LocalidadeId": "",
"EnderecoInstalacao_BairroId": "",
"EnderecoInstalacao_LogradouroId": "",
"EnderecoInstalacao_GoogleMapsPlaceId": "",
"EnderecoInstalacao_Latitude": "",
"EnderecoInstalacao_Longitude": "",
"Vendedor": "Maria",
"Adesao_Valor": "0.00",
"Cliente_Tipo": "F",
"Cliente_CPF_CNPJ": "43376452091",
"Cliente_Tel_Comercial": "",
"Cliente_Tel_Residencial": "",
"Cliente_Tel_Celular": "",
"Cliente_RG_IE": "",
"Cliente_Sigla": "",
"Cliente_Bloqueavel": "N",
"Aceite_Eletronico": "N",
"Aceite_Eletronico_Data": "",
"Aceite_Eletronico_IP": "",
"Aceite_Eletronico_Origem": "",
"Plano_Valor": "25.00",
"Plano_Tipo": "T",
"Cliente_Email": "joao.silva@provedor.com",
"Cliente_Grupo": "(SEM GRUPO)",
"Cancelamento_Motivo": "",
"Cancelamento_Concorrencia": "",
"Ultima_Operacao_Usuario": "",
"Data_Validade": "2023-01-24",
"Vigencia_Situacao": "Vencido",
"Qtde_Dias_Vencido": "354",
"Cancelamento_Agendado_Data": "",
"Cancelamento_Agendado_Registro": "",
"Cancelamento_Agendado_Usuario": "",
"SLA": "",
"QoS": "",
"Tecnologia": ""
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaContratos Sim Raiz - Nome
do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Cliente_Codigo Número Código do cliente. Cliente_Nome
Texto Nome do cliente. Numero Número Número do contrato. Plano_Codigo Número
Código do plano. Plano_Descricao Texto Descrição do plano. Pacote_Codigo Número
Código do pacote. Pacote_Descricao Texto Descrição do pacote. Pacote_PacoteID
Número Código do PacoteID. Situacao_Codigo Texto Código da situação: E:
Aguardando Instalação; I: Em Instalação; A: Ativo; B: Bloqueado; S: Suspenso; C:
Cancelado; T: Transferido. Situacao_Descricao Texto Descrição da situação.
Modelos_Contrato Texto Lista contendo os ids dos modelos de contrato. Assinatura
Data Data de assinatura. Inicio Data Data de início. DataUltimaOperacao Data
Data da última operação para contratos nas situações: Bloqueado, Cancelado,
Suspenso ou Transferido. CicloFaturamento_DiaBase Número Dia base do ciclo de
faturamento. CicloFaturamento_Vencimento Número Dia de vencimento do ciclo de
faturamento. ValorBruto Decimal(15.2) Valor bruto. DescontoFixo Decimal(15.2)
Valor do desconto fixo. ValorLiquido Decimal(15.2) Valor líquido (Valor bruto –
Valor do desconto fixo). DescontoPromocional_Valor Decimal(15.2) Valor do
desconto promocional. DescontoPromocional_Prazo Número Quantidade de períodos do
desconto promocional. Vigencia Número Quantidade de períodos da vigência.
Agrupamento Texto Informação sobre o agrupamento. Assinado Texto Informação da
assinatura. EnderecoCobranca_Logradouro Texto Logradouro do endereço de
cobrança. EnderecoCobranca_Numero Número Número do endereço de cobrança.
EnderecoCobranca_Complemento Texto Complemento do endereço de cobrança.
EnderecoCobranca_Bairro Texto Bairro do endereço de cobrança.
EnderecoCobranca_Cidade Texto Cidade do endereço de cobrança.
EnderecoCobranca_UF Texto Sigla da UF do endereço de cobrança.
EnderecoCobranca_CEP Texto CEP do endereço de cobrança. EnderecoCobranca_Pais
Texto País do endereço de cobrança. EnderecoCobranca_LocalidadeId Número Código
interno da localidade do endereço de cobrança (Referente à base local de
endereços). EnderecoCobranca_BairroId Número Código interno do bairro do
endereço de cobrança (Referente à base local de endereços).
EnderecoCobranca_LogradouroId Número Código interno do logradouro do endereço de
cobrança (Referente à base local de endereços).
EnderecoCobranca_GoogleMapsPlaceId Texto Código do endereço de cobrança no
Google Maps (Referente ao recurso de autocomplete). EnderecoCobranca_Latitude
Decimal(16.13) Latitude do endereço de cobrança. EnderecoCobranca_Longitude
Decimal(16.13) Longitude do endereço de cobrança.
EnderecoInstalacao_UsadoParaCobranca Texto Informação sobre a utilização do
endereço de instalação como endereço de cobrança. EnderecoInstalacao_Logradouro
Texto Logradouro do endereço de instalação. EnderecoInstalacao_Numero Número
Número do endereço de instalação. EnderecoInstalacao_Complemento Texto
Complemento do endereço de instalação. EnderecoInstalacao_Bairro Texto Bairro do
endereço de instalação. EnderecoInstalacao_Cidade Texto Cidade do endereço de
instalação. EnderecoInstalacao_UF Texto Sigla da UF do endereço de instalação.
EnderecoInstalacao_CEP Texto CEP do endereço de instalação.
EnderecoInstalacao_Pais Texto País do endereço de instalação.
EnderecoInstalacao_LocalidadeId Número Código interno da localidade do endereço
de instalação (Referente à base local de endereços). EnderecoInstalacao_BairroId
Número Código interno do bairro do endereço de instalação (Referente à base
local de endereços). EnderecoInstalacao_LogradouroId Número Código interno do
logradouro do endereço de instalação (Referente à base local de endereços).
EnderecoInstalacao_GoogleMapsPlaceId Texto Código do endereço de instalação no
Google Maps (Referente ao recurso de autocomplete). EnderecoInstalacao_Latitude
Decimal(16.13) Latitude do endereço de instalação. EnderecoInstalacao_Longitude
Decimal(16.13) Longitude do endereço de instalação. Vendedor Texto Vendedor.
Adesao_Valor Decimal(15.2) Valor de adesão. Cliente_Tipo Texto Tipo de cliente:
F: Pessoa física; J: Pessoa jurídica. Cliente_CPF_CNPJ Número CPF para pessoa
física ou CNPJ para pessoa jurídica. Cliente_Tel_Comercial Número Número do
telefone comercial. Cliente_Tel_Residencial Número Número do telefone
residencial. Cliente_Tel_Celular Número Número do telefone celular.
Cliente_RG_IE Número Registro Geral ou Inscrição Estadual. Cliente_Sigla Texto
Apelido para pessoa física ou nome fantasia para pessoa jurídica.
Cliente_Bloqueavel Texto Bloqueável: S: Sim; N: Não. Aceite_Eletronico Texto
Aceite eletrônico: S: Sim; N: Não. Aceite_Eletronico_Data Data Data da
assinatura. Aceite_Eletronico_IP Número IP da assinatura.
Aceite_Eletronico_Origem Texto Origem da assinatura. Plano_Valor Decimal(15.2)
Valor do plano. Plano_Tipo Texto Tipo do plano. Cliente_Email Texto E-mail do
cliente. Cliente_Grupo Texto Grupo do cliente. Cancelamento_Motivo Texto Motivo
do cancelamento. Cancelamento_Concorrencia Texto Código da concorrência.
Ultima_Operacao_Usuario Texto Usuário da última operação. Data_Validade Data
Data da validade do contrato. Vigencia_Situacao Texto Situação da vigencia.
Qtde_Dias_Vencido Número Quantidade de dias vencido. Cancelamento_Agendado_Data
Texto Data do cancelamento agendado. Cancelamento_Agendado_Registro Texto Data
de inclusão do agendamento de cancelamento. Cancelamento_Agendado_Usuario Texto
Usuário do agendamento de cancelamento. SLA Texto SLA. QoS Texto QoS. Tecnologia
Texto Tecnologia.
CONSULTA CONTRATOS BLOQUEADOS
O objetivo deste serviço é retornar uma lista com os contratos que estão
atualmente bloqueados no RBX.
> Request Example:
Copy to Clipboard{
"ConsultaContratosBloqueados": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Cliente_Nome = 'João da Silva'"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Contrato_Numero": "123",
"Contrato_Descricao": "Plano 500MB",
"Contrato_Bloqueio": "2024-01-10",
"Contrato_Bloqueio_Usuario": "usuario",
"Cliente_Codigo": "1",
"Cliente_Nome": "João da Silva"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaContratosBloqueados Sim
Raiz - Nome do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Contrato_Numero Número Número do contrato.
Contrato_Descricao Texto Descrição do plano do contrato. Contrato_Bloqueio Data
Data do bloqueio do contrato. Contrato_Bloqueio_Usuario Texto Usuário que
bloqueou o contrato. Cliente_Codigo Número Código do cliente. Cliente_Nome Texto
Nome do cliente.
CONSULTA MOTIVOS DE CANCELAMENTO
O objetivo deste serviço é retornar uma lista com os motivos de cancelamento
cadastrados no RBX. Atenção: este serviço não possui suporte a filtros.
> Request Example:
Copy to Clipboard{
"ConsultaMotivosCancelamento": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
}
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"id": "1",
"Nome": "Cobrador Virtual"
},
{
"id": "2",
"Nome": "Insatisfação"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 97,
"erro_inf": "",
"erro_desc": "Erro de integracao",
"erro_detail": "Chave de integracao invalida ou inativa",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaMotivosCancelamento Sim
Raiz - Nome do serviço.
CAMPOS DO RETORNO
Campo Tipo Observações id Número Código do motivo. Nome Texto Nome do motivo.
ESTOQUE
CONSULTA MODELOS DE PRODUTOS
O objetivo deste serviço é retornar uma lista com os modelos de produtos
cadastrados no RBX.
> Request Example:
Copy to Clipboard{
"ConsultaModelosProduto": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Codigo = '1'"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Codigo": "1",
"Tipo_Descricao": "Rádio",
"Tipo_Id": "1",
"Descricao": "Rádio",
"Marca": ""
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaModelosProduto Sim Raiz -
Nome do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Codigo Número Código do modelo. Tipo_Descricao Texto
Descrição do tipo de produto vinculado ao modelo. Tipo_Id Número Id do tipo de
produto vinculado ao modelo. Descricao Texto Descrição do modelo. Marca Texto
Descrição da marca do modelo.
CONSULTA TIPOS DE PRODUTOS
O objetivo deste serviço é retornar uma lista com os tipos de produto
cadastrados no RBX.
> Request Example:
Copy to Clipboard{
"ConsultaTiposProduto": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Codigo = '1'"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Codigo": "1",
"Descricao": "Rádio"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaTiposProduto Sim Raiz -
Nome do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Codigo Número Código do tipo. Descricao Texto Descrição
do tipo.
CONSULTA UNIDADES DE PRODUTOS
O objetivo deste serviço é retornar uma lista com as unidades de produtos
cadastradas no RBX.
> Request Example:
Copy to Clipboard{
"ConsultaUnidadesProduto": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Codigo = '1'"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Codigo": "1",
"Sigla": "UN",
"Descricao": "Unidade"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaUnidadesProduto Sim Raiz -
Nome do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Codigo Número Código da unidade. Sigla Texto Sigla da
unidade. Descricao Texto Descrição da unidade.
FINANCEIRO
CADASTRO DE NOTAS FISCAIS
O objetivo deste serviço é realizar o cadastro de notas fiscais de modelo 21 e
22 no RBX.
> Request Example:
Copy to Clipboard{
"NotasFiscaisCadastro": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"DadosNota": {
"Nota": {
"Cabecalho": {
"CodigoCliente": "9",
"Modelo": "21",
"DataEmissao": "2023-12-01",
"TipoUtilizacao": "4",
"NaturezaOperacao": "Prestacao de Servicos de Comunicacao",
"InformacoesAdicionais": "Informações adicionais da nota",
"Situacao": "N"
},
"Itens": {
"Item": {
"Codigo": "RBX2023",
"Descricao": "Descrição do item 1",
"CFOP": "5301",
"Unidade": "UN",
"Valor": "150.00",
"ICMSValorBaseCalculo": "100.00",
"ICMSValorAliquota": "10.00",
"ICMSCodigoReducaoBaseCalculo": "01",
"CodigoClassificacaoItem": "104"
}
}
}
}
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": {
"QuantidadeNotas": 1
}
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 98,
"erro_inf": "Nota 1",
"erro_desc": "Data de emissão menor que o permitido",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 NotasFiscaisCadastro Sim Raiz -
Nome do serviço. B01 DadosNota Sim A01 - Dados das notas fiscais. C01 Nota Sim
B01 - Grupo que contém os dados de uma nota específica. D01 Cabecalho Sim C01 -
Grupo com os dados do cabeçalho da nota. D02 CodigoCliente Sim D01 Número Código
do cliente. D03 Modelo Sim D01 Número Modelo da nota. D04 DataEmissao Sim D01
Data Data de emissão da nota. D05 TipoUtilizacao Sim D01 Número Tipo de
utilização. Valores permitidos: 1: Telefonia; 2: Comunicação de dados; 3: TV por
Assinatura; 4: Provimento de acesso à Internet; 5: Multimídia; 6: Outros. D06
NaturezaOperacao Sim D01 Texto Texto descritivo. D07 InformacoesAdicionais Não
D01 Texto Texto descritivo. D08 Situacao Sim D01 Texto Situação. Valores
permitidos: N: Normal; C: Cancelada. E01 Itens Sim C01 - Grupo que contém todos
os itens da nota F01 Item Sim E01 - Grupo com os dados do item. F02 Codigo Sim
F01 Número Código do item. F03 Descricao Sim F01 Texto Descrição do item. F04
CFOP Sim F01 Número Código Fiscal de Operação e Prestações. F05 Unidade Sim F01
Texto Unidade de medida do item. F06 Valor Sim F01 Decimal(15.2) Valor do item.
F07 ICMSValorBaseCalculo Não F01 Decimal(3.2) Valor da base de cálculo do ICMS.
F08 ICMSValorAliquota Não F01 Decimal(3.2) Valor alíquota de ICMS. F09
ICMSCodigoReducaoBaseCalculo Não F01 Número Código de redução da base de cálculo
de ICMS. F10 CodigoClassificacaoItem Sim F01 Número Classificação do item.
CONSULTA CARTÕES CADASTRADOS
O objetivo deste serviço é retornar uma lista com os cartões cadastrados para
clientes e mercados.
> Request Example:
Copy to Clipboard{
"ConsultaCartoesCadastrados": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "TipoPessoa = 'C' AND CodigoPessoa = 1"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Id": "10",
"TipoPessoa": "C",
"CodigoPessoa": "1",
"UltimosDigitos": "3180",
"Bandeira": "M",
"TipoCartao": "A",
"CartaoPadrao": "N"
},
{
"Id": "11",
"TipoPessoa": "C",
"CodigoPessoa": "1",
"UltimosDigitos": "4876",
"Bandeira": "M",
"TipoCartao": "C",
"CartaoPadrao": "N"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaCartoesCadastrados Sim
Raiz - Nome do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Id Número Id do cartão. TipoPessoa Texto Tipo de pessoa:
C: Cliente; M: Mercado. CodigoPessoa Número Código do cliente/mercado.
UltimosDigitos Número Últimos 4 dígitos do cartão. Bandeira Texto Bandeira do
cartão: A: American Express; D: Diners; E: Elo; H: Hipercard; J: JCB; M:
MasterCard; R: Discover; U: Aura; V: Visa. TipoCartao Texto Tipo do cartão: C:
Crédito; D: Débito; M: Múltiplo. CartaoPadrao Texto Informação se é o cartão
padrão do cliente/mercado: S: Sim; N: Não.
CONSULTA CICLOS DE FATURAMENTO
O objetivo deste serviço é retornar uma lista com os ciclos de faturamento
cadastrados no RBX. Atenção: este serviço não possui suporte a filtros.
> Request Example:
Copy to Clipboard{
"ConsultaCiclosFaturamento": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
}
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"id": "1",
"Dia": "1",
"Vencimento": "1",
"Situacao": "A",
"Descricao": "01 a 31 / 01"
},
{
"id": "2",
"Dia": "1",
"Vencimento": "5",
"Situacao": "I",
"Descricao": "01 a 31 / 05"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 97,
"erro_inf": "",
"erro_desc": "Erro de integracao",
"erro_detail": "Chave de integracao invalida ou inativa",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaCiclosFaturamento Sim Raiz
- Nome do serviço.
CAMPOS DO RETORNO
Campo Tipo Observações id Número Código do ciclo de faturamento. Dia Número Dia
do início do ciclo. Vencimento Número Dia de vencimento do ciclo. Situacao Texto
Situação do ciclo de faturamento: A: Ativo; I: Inativo. Descricao Texto
Descrição do ciclo no formato: [Dia Inicial] a [Dia Final] / [Dia Vencimento]
CONSULTA DOCUMENTOS BAIXADOS
O objetivo deste serviço é retornar uma lista com os documentos baixados no RBX.
> Request Example:
Copy to Clipboard{
"ConsultaDocumentosBaixados": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Movimento.Tipo = 'C' AND Movimento.Cliente = 10"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Sequencia": "138",
"Tipo": "C",
"Cobranca": "R",
"CodigoPessoa": "10",
"DocumentoPessoa": "43376452091",
"NomePessoa": "João da Silva",
"Conta": "3",
"Historico": "Documento a Receber",
"HistoricoBaixa": "",
"ContaContrapartida": "0",
"Documento": "106",
"NossoNumero": "21200003",
"Origem": "FAT",
"Banco": "748",
"Convenio": "2237",
"Complemento": "Carnê 1",
"DataLancamento": "2024-01-01",
"DataVencimento": "2024-01-20",
"DataBaixa": "2024-01-20",
"Motivo": "PAGTO",
"FormaPagto": "N",
"ValorOriginal": "100.00",
"ValorJuros": "0.00",
"ValorMulta": "0.00",
"ValorDesconto": "100.00",
"ValorBaixado": "0.00",
"UsuarioBaixa": "routerbox",
"DataHoraExecucaoBaixa": "2024-01-20 12:00:00"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaDocumentosBaixados Sim
Raiz - Nome do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Sequencia Número Código interno do documento. Tipo Texto
Tipo do cliente: C: Cliente; F: Fornecedor; M: Mercado. Cobranca Texto Tipo de
cobrança: S: Cobrança Simples; R: Cobrança Registrada; D: Débito em Conta; C:
Cartão de Crédito. CodigoPessoa Número Código do cliente/mercado/fornecedor.
DocumentoPessoa Número CPF/CNPJ do cliente/mercado/fornecedor. NomePessoa Texto
Nome do cliente/mercado/fornecedor. Conta Número Número da conta corrente na
qual o documento foi lançado. Historico Texto Descrição do histórico de
lançamento do documento. HistoricoBaixa Texto Descrição do histórico de baixa do
documento. ContaContrapartida Número Número da conta de contrapartida para
baixas de documentos vinculados a históricos A Prazo e com Contrapartida. Em
resumo, a conta na qual houve crédito/débito do valor recebido/pago. Documento
Número Número do documento financeiro. NossoNumero Número Nosso Número do
documento financeiro (Apenas para boletos). Origem Texto Origem do documento:
ADE: Adesão; FAT: Faturamento; OUT: Outros; SER: Serviços; VEN: Vendas. Banco
Número Número do banco de lançamento do documento. Para zero, considerar
lançamentos em carteira. Convenio Número Número do convênio bancário vinculado
ao documento. Complemento Texto Complemento do documento. DataLancamento Data
Data de lançamento do documento. DataVencimento Data Data de vencimento do
documento. DataBaixa Data Data de baixa do documento. Motivo Texto Motivo da
baixa: PAGTO: Pagamento; CANC: Cancelamento (Não é estorno); RENEG:
Renegociação; TRANS: Transferência entre contas. FormaPagto Texto Forma de
pagamento: N: Normal; C: Cartão de crédito (on-line); D: Cartão de débito
(on-line); CM: Cartão de crédito (máquina); DM: Cartão de débito (máquina);
Multimoeda: Baixa com várias moedas (Apenas para licenças de outros países).
ValorOriginal Decimal(15.2) Valor original do documento. ValorJuros
Decimal(15.2) Valor dos juros aplicado na baixa. ValorMulta Decimal(15.2) Valor
da multa aplicada na baixa. ValorDesconto Decimal(15.2) Valor do desconto
concedido na baixa. ValorBaixado Decimal(15.2) Valor total baixado. Equivale à
operação: ValorBaixado = ValorOriginal + ValorJuros + ValorMulta - ValorDesconto
UsuarioBaixa Texto Usuário que efetuou a baixa. DataHoraExecucaoBaixa Data/Hora
Data e hora da execução da baixa.
FILTROS DISPONÍVEIS
Campo Tipo Observações Sequencia Número Movimento.Sequencia Tipo Texto
Movimento.Tipo Cobranca Texto Movimento.Cobranca CodigoPessoa Número
Movimento.Cliente DocumentoPessoa Número Clientes.CNPJ_CNPF
Fornecedores.CNPJ_CNPF
Mercado.CNPJ_CNPF NomePessoa Texto Clientes.Nome
Fornecedores.Nome
Mercado.Nome Conta Número Movimento.Conta Historico Texto Historicos.Descricao
HistoricoBaixa Texto HistoricosBaixa.Descricao ContaContrapartida Número
Movimento.BxCPartida Documento Número Movimento.Documento NossoNumero Número
Movimento.NroBanco Origem Texto Movimento.Origem Banco Número Movimento.BcoCobr
Convenio Número Movimento.Convenio Complemento Texto Movimento.Complemento
DataLancamento Data Movimento.DataLancto DataVencimento Data Movimento.Data
DataBaixa Data Movimento.DataBaixa Motivo Texto Movimento.MotivoBaixa FormaPagto
Texto Movimento.FormaPagto ValorOriginal Decimal(15.2) Movimento.Valor
ValorJuros Decimal(15.2) Movimento.BxJuros ValorMulta Decimal(15.2)
Movimento.BxMulta ValorDesconto Decimal(15.2) Movimento.BxDesconto UsuarioBaixa
Texto Movimento.Bxusuario DataHoraExecucaoBaixa Data/Hora
Movimento.BaixaDataHora
CONSULTA DOCUMENTOS EM ABERTO
O objetivo deste serviço é retornar uma lista com os documentos em aberto no
RBX.
> Request Example:
Copy to Clipboard{
"ConsultaDocumentosAbertos": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Cliente = 1"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Conta": "3",
"Vencimento": "2024-15-01",
"Documento": "1000",
"Historico": "Documento a Receber",
"Complemento": "",
"Origem": "FAT",
"Valor": "100.00",
"Tipo": "C",
"CliFor": "1",
"Banco": "748",
"NossoNumero": "1000",
"ContratosVinculados": "",
"Sequencia": "12345",
"RegistradoNoBanco": "N"
},
{
"Conta": "3",
"Vencimento": "2024-15-02",
"Documento": "1001",
"Historico": "Documento a Receber",
"Complemento": "",
"Origem": "FAT",
"Valor": "100.00",
"Tipo": "C",
"CliFor": "1",
"Banco": "748",
"NossoNumero": "1001",
"ContratosVinculados": "",
"Sequencia": "12346",
"RegistradoNoBanco": "N"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaDocumentosAbertos Sim Raiz
- Nome do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Conta Número Número da conta corrente na qual o documento
foi gerado. Vencimento Data Data de vencimento do documento (No filtro, utilizar
o valor Data). Documento Número Número de identificação do documento no RBX.
Historico Texto Descrição do histórico do documento. Complemento Texto
Complemento do documento. Origem Texto Origem do documento: FAT: Faturamento;
ADE: Adesão; VEN: Venda; SER: Serviço; OUT: Outros. Valor Decimal(15.2) Valor do
documento. Tipo Texto Tipo do cliente: C: Cliente; F: Fornecedor; M: Mercado.
CliFor Número Código do cliente/mercado/fornecedor (No filtro, utilizar o valor
Cliente). Banco Número Código do banco ao qual o documento pertence (No filtro,
utilizar o valor BcoCobr). NossoNumero Número Número de identificação do
documento junto ao banco (No filtro, utilizar o valor NroBanco).
ContratosVinculados Texto Lista de contratos (separados por vírgula) vinculados
ao documento. Sequencia Número Código interno do documento. RegistradoNoBanco
Texto Documento registrado no banco: S: Sim; N: Não.
FILTROS ADICIONAIS DISPONÍVEIS
Campo Tipo Observações DataLancto Data Data de lançamento do documento.
CONSULTA GRUPOS DE COBRANÇA
O objetivo deste serviço é retornar uma lista com os grupos de cobrança
cadastrados no RBX. Atenção: este serviço não possui suporte a filtros.
> Request Example:
Copy to Clipboard{
"ConsultaGruposCobranca": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
}
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Codigo": "1",
"Nome": "Grupo de Cobrança I"
},
{
"Codigo": "2",
"Nome": "Grupo de Cobrança II"
},
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 97,
"erro_inf": "",
"erro_desc": "Erro de integracao",
"erro_detail": "Chave de integracao invalida ou inativa",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaGruposCobranca Sim Raiz -
Nome do serviço.
CAMPOS DO RETORNO
Campo Tipo Observações Codigo Número Código do grupo. Nome Texto Nome do grupo.
CONSULTA LINHA DIGITÁVEL DO BOLETO
O objetivo deste serviço é retornar uma lista com as linhas digitáveis dos
boletos existentes no RBX.
> Request Example:
Copy to Clipboard{
"ConsultaLinhaDigitavelBoleto": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"DadosLinhaDigitavelEntrada": {
"Tipo": "C",
"CliFor": 1,
"Documento": 12345
}
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"LinhaDigitavel": "74891.12347 02320.907239 21132.371060 1 95430000020000"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "Documento nao localizado",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaLinhaDigitavelBoleto Sim
Raiz - Nome do serviço. B01 DadosLinhaDigitavelEntrada Sim A01 - Grupo que
contém os dados dos documentos que serão filtrados. B02 BoletoAtualizado Não B01
Texto Boleto atualizado. Valores permitidos: N: Gerar linha digitável com a data
de vencimento original; S: Gerar linha digitável com a data de vencimento
atualizada. B03 Conta Não B01 Número Conta corrente onde foi lançado o
documento. B04 Vencimento Não B01 Data Data de vencimento do documento. B05
Documento Não B01 Número Número do documento. B06 Origem Não B01 Texto Origem do
documento. Valores permitidos: FAT: Faturamento; SER: Serviços; ADE: Adesão;
VEN: Venda; OUT: Outros. B07 Tipo Não B01 Texto Tipo do cliente. Valores
permitidos: C: Cliente; F: Fornecedor; M: Mercado. B08 CliFor Sim B01 Número
Código do cliente, fornecedor ou mercado. B09 Banco Não B01 Número Número do
banco.
VARIADOS
CADASTRO DE PEDIDOS
O objetivo deste serviço é realizar o cadastro de um novo pedido avulso no RBX.
> Request Example:
Copy to Clipboard{
"PedidoCadastro": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"DadosPedido": {
"Geral": {
"Cliente": "6",
"TipoCliente": "C",
"CicloFat": "1",
"Assinatura": "2023-12-01",
"Vendedor": "joao.silva",
"Usuario": "joao.silva"
},
"EnderecoInstalacao": {
"Endereco": "Rua Presidente Nereu Ramos",
"Numero": "1001",
"Complemento": "",
"Bairro": "Centro",
"CodMunicipio": "4114807",
"UF": "PR",
"CEP": "86990000"
},
"EnderecoCobranca": {
"Endereco": "Rua Presidente Nereu Ramos",
"Numero": "1002",
"Complemento": "",
"Bairro": "Centro",
"CodMunicipio": "4114807",
"UF": "PR",
"CEP": "86990000"
},
"Adesao": {
"TipoPlano": "",
"CodigoPlano": "1",
"NroParcelas": "2",
"FormaPagto": "",
"Cobranca": "",
"Conta": "3",
"Historico": "1",
"Banco": "104",
"Convenio": "123456",
"PreLancamentoContabil": "",
"Parcelas": {
"Parcela": [
{
"Descricao": "Parcelas Pedido 001",
"Vencimento": "2023-12-10",
"Valor": "50.00"
},
{
"Descricao": "Parcelas Pedido 001",
"Vencimento": "2024-01-10",
"Valor": "50.00"
}
]
}
},
"Itens": {
"ItemP": {
"Tipo": "P",
"Codigo": "1",
"InicioCobranca": "2023-12-01",
"AgruparCobranca": "S",
"DescPromoPrazo": "12",
"DescPromoValor": -20,
"DescPromoDesc": "DESCONTO PROMOCIONAL"
}
}
}
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": {
"NumeroPedido": "1576",
"Mensagem": "Pedido cadastrado com sucesso"
}
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 135,
"erro_inf": "",
"erro_desc": "Adesao - nenhuma parcela informada",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 PedidoCadastro Sim Raiz - Nome do
serviço. B01 DadosPedido Sim A01 - Dados do pedido. C01 Geral Sim B01 - Dados
gerais do pedido. C02 Cliente Sim C01 Número Código do cliente ou mercado. C03
TipoCliente Sim C01 Texto Tipo do cliente. Valores permitidos: C: Cliente; M:
Mercado. C04 Atendimento Não C01 Número Número do atendimento vinculado ao
pedido, existente no RBX. C05 CicloFat Sim C01 Número Código do ciclo de
faturamento para este pedido, existente no RBX. C06 Assinatura Sim C01 Data Data
de assinatura dos contratos do pedido. C07 Vendedor Não C01 Texto Nome do
vendedor. C08 Observacoes Não C01 Texto Texto livre. C09 Usuario Sim C01 Texto
Usuário de abertura do pedido. Não informando a tag, o sistema assumirá o
usuário padrão do Web Service. D01 EnderecoInstalacao Não B01 - Grupo que contém
os dados do endereço de instalação dos contratos. D02 Endereco Sim D01 Texto
Endereço. D03 Numero Sim D01 Número Número do endereço. D04 Complemento Não D01
Texto Complemento do endereço. D05 Bairro Sim D01 Texto Bairro do endereço. D06
CodMunicipio Sim D01 Número Código do município do cliente de acordo com a
tabela de municípios do IBGE. D07 UF Sim D01 Texto UF do endereço. D08 CEP Sim
D01 Número CEP do endereço. E01 EnderecoCobranca Não B01 - Grupo que contém os
dados do endereço de cobrança dos contratos. E02 Endereco Sim E01 Texto
Endereço. E03 Numero Sim E01 Número Número do endereço. E04 Complemento Não E01
Texto Complemento do endereço. E05 Bairro Sim E01 Texto Bairro do endereço. E06
CodMunicipio Sim E01 Número Código do município do cliente de acordo com a
tabela de municípios do IBGE. E07 UF Sim E01 Texto UF do endereço. E08 CEP Sim
E01 Número CEP do endereço. F01 Adesao Não B01 - Grupo que contém os dados para
geração da adesão do pedido. F02 TipoPlano Sim F01 Texto Tipo do plano. Valores
permitidos: P: Plano; O: Pacote. F03 CodigoPlano Sim F01 Número Informar o
código de um dos itens do pedido – plano ou pacote – que será utilizado como
base para geração da nota fiscal de adesão. F04 NroParcelas Sim F01 Número
Quantidade de parcelas da adesão. F05 FormaPagto Sim F01 Texto Forma de
pagamento. Valores permitidos: B: Boleto bancário; P: Cobrar junto com o
faturamento mensal. F06 Cobranca Sim F01 Texto Tipo de cobrança. Valores
permitidos: S: Cobrança Simples; R: Cobrança Registrada. F07 Conta Sim F01
Número Conta corrente para geração dos boletos bancários referentes à adesão do
pedido. Informar o número de uma das contas cadastradas no RBX considerando: A
conta deve aceitar faturamentos; A conta deve ser de natureza Recebimentos. F08
Historico Sim F01 Número Histórico para geração dos boletos bancários referentes
à adesão do pedido. Informar o número de um dos históricos cadastrados no RBX
considerando: O histórico deve ser do tipo Prazo; O histórico deve ser de
operação Crédito. F09 Banco Sim F01 Número Local de cobrança padrão do cliente.
Informar o código de um dos bancos cadastrados no RBX. F10 Convenio Sim F01
Número Código do convênio bancário cadastrado para o banco informado no campo
F09. F11 PreLancamentoContabil Não F01 Número Código de um dos pré-lançamentos
contábeis cadastrados no RBX. G01 Parcelas Não B01 - Grupo que contém os dados
para geração das parcelas de adesão. H01 Parcela Não G01 - Informar um grupo H01
para cada parcela. H02 Descricao Sim H01 Texto Descrição da parcela que será
mostrada no boleto bancário. H03 Vencimento Sim H01 Data Data de vencimento da
parcela. H04 Valor Sim H01 Decimal(15.2) Valor da parcela. I01 Itens Sim B01 -
Grupo que contém os itens (Planos e pacotes) que compõem o pedido. J01 ItemP Sim
I01 - Informar um grupo J01 para cada item do pedido. J02 Tipo Sim J01 Texto
Tipo do item. Valores permitidos: P: Plano; O: Pacote. J03 Codigo Sim J01 Número
Código do plano ou pacote existente no RBX, conforme o valor informado para o
banco J02. J04 DescontoAdesao Não J01 Decimal(15.2) Valor do desconto concedido
na adesão. J05 DescontoContrato Não J01 Decimal(15.2) Valor do desconto fixo
concedido no item. J06 Vigencia Não J01 Número Vigência do item. J07
DescPromoPrazo Não J01 Número Período de vigência do desconto promocional do
item. J08 DescPromoValor Não J01 Decimal(15.2) Valor do desconto promocional do
item. J09 DescPromoDesc Não J01 Texto Descrição do desconto promocional do item.
O valor informado neste campo será destacado no boleto. Se nenhum valor for
informado, o desconto será subtraído do valor final do contrato. J10
InicioCobranca Sim J01 Data Data de início da cobrança do item (data de início
do contrato) para efeitos de cobrança. J11 AgruparCobranca Sim J01 Texto Define
o critério de agrupamento dos contratos. Valores permitidos: S: Agrupar
contrato; N: Não agrupar contrato; Qualquer valor inteiro entre 1 e 20: Os
contratos com o mesmo número serão agrupados entre si J12 QoS Não J01 Número
Código de um dos QoS cadastrados no RBX. J13 GrupoSLA Não J01 Número Código de
um dos Grupos de SLA cadastrados no RBX. J14 PTerceiro Não J01 Número Código de
um dos terceiros cadastrados no RBX, quando o item prevê um terceiro (cobrança
por terceiros). J15 DTerceiro Não J01 Número Código de um dos terceiros
cadastrados no RBX, quando o item prevê um terceiro (cobrança de terceiros).
CONSULTA DADOS ADICIONAIS
O objetivo deste serviço é retornar uma lista com os dados adicionais
cadastrados no RBX. Atenção: este serviço não possui suporte a filtros.
> Request Example:
Copy to Clipboard{
"ConsultaDadosAdicionais": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
}
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Codigo": "1",
"Tabela": "Contratos",
"Nome": "Número de Controle do VSC"
},
{
"Codigo": "2",
"Tabela": "Clientes",
"Nome": "Clientes_Filial"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 97,
"erro_inf": "",
"erro_desc": "Erro de integracao",
"erro_detail": "Chave de integracao invalida ou inativa",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaDadosAdicionais Sim Raiz -
Nome do serviço.
CAMPOS DO RETORNO
Campo Tipo Observações Codigo Número Código do dado adicional. Tabela Texto
Tabela na qual o dado adicional pode ser utilizado. Nome Texto Nome do dado
adicional.
CONSULTA EVENTOS DO FAILOVER
O objetivo deste serviço é retornar uma lista com os eventos do FailOver.
> Request Example:
Copy to Clipboard{
"FailOverEvents": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Type = 'LINK'"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Id": "151",
"Host": "100.0.0.1",
"Type": "LINK",
"Server": "1",
"AffectedCustomers": "-1",
"DownTime": "2023-08-10 10:03:03",
"UpTime": "2023-08-10 10:04:01",
"Status": "C",
"Source": "A",
"Description": "Teste do failover",
"Duration": "",
"Cause": "",
"Solution": ""
},
{
"Id": "152",
"Host": "100.0.0.2",
"Type": "LINK",
"Server": "1",
"AffectedCustomers": "-1",
"DownTime": "2023-08-14 14:29:04",
"UpTime": "2023-08-14 14:30:01",
"Status": "C",
"Source": "A",
"Description": "Teste do failover",
"Duration": "",
"Cause": "",
"Solution": ""
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Descrição A01 FailOverEvents Sim Raiz - Nome do
serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Id Número Id do evento. Host Texto Host do evento. Type
Texto Tipo do evento: NAS; LINK; LINK_VIR; DNSR; DNSF; PROXY. Server Texto
Servidor do evento. AffectedCustomers Texto Clientes afetados pelo evento.
DownTime Data/Hora Início do evento. UpTime Data/Hora Término do evento. Status
Texto Situação do evento: O: Aberto; C: Finalizado. Source Texto Origem do
evento: A: Automático; M: Manual. Description Texto Descrição do evento.
Duration Número Duração do evento. Cause Número Causa de encerramento do
atendimento vinculado ao evento. Solution Texto Solução de encerramento do
atendimento vinculado ao evento.
CONSULTA FORNECEDORES
O objetivo deste serviço é retornar uma lista com os fornecedores cadastrados no
RBX.
> Request Example:
Copy to Clipboard{
"ConsutaFornecedores": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Codigo = 1"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Codigo": "1",
"Tipo": "J",
"CNPJ_CNPF": "08064005000190",
"Nome": "CIELO S.A.",
"Endereco": "Alameda Xingu",
"Numero": "512",
"Complemento": "ANDAR 21 AO 31",
"Bairro": "Alphaville Centro Industrial e Empresarial/Alphaville.",
"Cidade": "Barueri",
"UF": "SP",
"CEP": "06455030",
"Telefone1": "11999999999",
"Telefone2": "",
"TelFax": "",
"RG_IE": "",
"Sigla": "",
"Inclusao": "2020-07-04",
"Usuario": "usuario",
"Situacao": "A",
"Observacoes": ""
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsutaFornecedores Sim Raiz -
Nome do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações Codigo Número Código do fornecedor. Tipo Texto Tipo de
pessoa: F: Pessoa física; J: Pessoa jurídica. CNPJ_CNPF Número CPF para pessoa
física ou CNPJ para pessoa jurídica. Nome Texto Nome do fornecedor. Endereco
Texto Endereço do fornecedor. Numero Número Número do endereço. Complemento
Texto Complemento do endereço. Bairro Texto Bairro do endereço. Cidade Texto
Cidade do endereço. UF Texto UF do endereço. CEP Número CEP do endereço.
Telefone1 Número Telefone principal. Telefone2 Número Telefone. TelFax Número
Telefone/fax. RG_IE Texto RG ou Inscrição Estadual do fornecedor. Sigla Texto
Apelido para pessoa física ou nome fantasia para pessoa jurídica. Inclusao Data
Data de cadastro do fornecedor. Usuario Texto Usuário de cadastro do fornecedor.
Situacao Texto Situação do fornecedor: A: Ativo; I: Inativo. Observacoes Texto
Texto livre.
CONSULTA PLANOS
O objetivo deste serviço é retornar uma lista com os planos cadastrados no RBX.
Atenção: este serviço não possui suporte a filtros.
> Request Example:
Copy to Clipboard{
"ConsultaPlanos": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
}
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Codigo": "1",
"Descricao": "Plano 100MB",
"Grupo": "0"
},
{
"Codigo": "2",
"Descricao": "Plano 200MB",
"Grupo": "0"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 97,
"erro_inf": "",
"erro_desc": "Erro de integracao",
"erro_detail": "Chave de integracao invalida ou inativa",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaPlanos Sim Raiz - Nome do
serviço.
CAMPOS DO RETORNO
Campo Tipo Observações Codigo Número Código do plano. Descricao Texto Descrição
do plano. Grupo Texto Nome e descrição do grupo do plano.
CONSULTA QOS
O objetivo deste serviço é retornar uma lista com os QoS cadastrados no RBX.
Atenção: este serviço não possui suporte a filtros.
> Request Example:
Copy to Clipboard{
"ConsultaQoS": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
}
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Codigo": "1",
"Descricao": "Limitação Padrão"
},
{
"Codigo": "2",
"Descricao": "RBX Acelerado - 200%"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 97,
"erro_inf": "",
"erro_desc": "Erro de integracao",
"erro_detail": "Chave de integracao invalida ou inativa",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaQoS Sim Raiz - Nome do
serviço.
CAMPOS DO RETORNO
Campo Tipo Observações Codigo Número Código do QoS. Descricao Texto Descrição do
QoS.
CONSULTA STATUS DO NAS
O objetivo deste serviço é retornar uma lista com os IPs internos dos NAS e seu
status atual.
> Request Example:
Copy to Clipboard{
"ConsultaStatusNAS": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
},
"Filtro": "Online = 'N'"
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"IPInterno": "100.0.0.10",
"Online": "N"
},
{
"IPInterno": "100.0.0.11",
"Online": "N"
},
{
"IPInterno": "100.0.0.12",
"Online": "N"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 1,
"erro_inf": "",
"erro_desc": "A consulta nao retornou resultados",
"erro_detail": "",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaStatusNAS Sim Raiz - Nome
do serviço. B01 Filtro Não A01 - Filtro da consulta.
CAMPOS DO RETORNO
Campo Tipo Observações IPInterno Texto IP interno do NAS. Online Texto Indica se
o NAS está on-line ou off-line: S: On-line; N: Off-line.
Obs.: O sistema considera um NAS off-line quando sua última comunicação com o
sistema foi há mais de 90 segundos.
CONSULTA USUÁRIOS DO SISTEMA
O objetivo deste serviço é retornar uma lista com os usuários cadastrados no
RBX. Atenção: este serviço não possui suporte a filtros.
> Request Example:
Copy to Clipboard{
"ConsultaUsuarios": {
"Autenticacao": {
"ChaveIntegracao": "UAHS531AUSHUQ727182HNUHE18H37H"
}
}
}
> Response Example:
Copy to Clipboard{
"status": 1,
"erro_code": "",
"erro_inf": "",
"erro_desc": "",
"erro_detail": "",
"result": [
{
"Usuario": "user01",
"Situacao": "A"
},
{
"Usuario": "user02",
"Situacao": "A"
},
{
"Usuario": "user03",
"Situacao": "A"
}
]
}
> Error Example:
Copy to Clipboard{
"status": 0,
"erro_code": 97,
"erro_inf": "",
"erro_desc": "Erro de integracao",
"erro_detail": "Chave de integracao invalida ou inativa",
"result": ""
}
HTTP REQUEST
POST https://[minha_url]/routerbox/ws/rbx_server_json.php
PARÂMETROS DE ENVIO
ID Campo Obrigatório Pai Tipo Observações A01 ConsultaUsuarios Sim Raiz - Nome
do serviço.
CAMPOS DO RETORNO
Campo Tipo Observações Usuario Texto Usuário de acesso ao sistema. Situacao
Texto Situação do usuário: A: Ativo; B: Bloqueado; I: Inativo.