Mudanças entre as edições de "Web Services"
De RBX ISP - Manual do Usuário
| (10 revisões intermediárias pelo mesmo usuário não estão sendo mostradas) | |||
| Linha 13: | Linha 13: | ||
A codificação dos caracteres do JSON será sempre UTF-8. | A codificação dos caracteres do JSON será sempre UTF-8. | ||
| − | A seguir são listados os web services disponíveis | + | A seguir são listados os web services disponíveis a partir da versão 4.2 do sistema. |
== Atendimentos == | == Atendimentos == | ||
| Linha 23: | Linha 23: | ||
== Autenticações == | == Autenticações == | ||
| − | :*[ Alteração de autenticação] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Altera%C3%A7%C3%A3o_de_autentica%C3%A7%C3%A3o Alteração de autenticação] |
| − | :*[ Cadastro de autenticação] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Cadastro_de_autentica%C3%A7%C3%A3o Cadastro de autenticação] |
| − | :*[ Exclusão de autenticação] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Exclus%C3%A3o_de_autentica%C3%A7%C3%A3o Exclusão de autenticação] |
== Contatos == | == Contatos == | ||
| − | :*[ Cadastro de contatos] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Cadastro_de_contato Cadastro de contatos] |
== Contratos == | == Contratos == | ||
| − | :*[ Alteração de contrato em degustação] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Altera%C3%A7%C3%A3o_de_contrato_em_degusta%C3%A7%C3%A3o Alteração de contrato em degustação] |
| − | :*[ Assinatura de contrato] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Assinatura_de_contrato Assinatura de contrato] |
| − | :*[ Ativação de contrato] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Ativa%C3%A7%C3%A3o_de_contrato Ativação de contrato] |
| − | :*[ Bloqueio de contrato] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Bloqueio_de_contrato Bloqueio de contrato] |
| − | :*[ Cadastro de contrato de degustação] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Cadastro_de_contrato_de_degusta%C3%A7%C3%A3o Cadastro de contrato de degustação] |
| − | :*[ Cancelamento de contrato] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Cancelamento_de_contrato Cancelamento de contrato] |
| − | :*[ Cancelamento de suspensão temporária de contrato] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Cancelamento_de_suspens%C3%A3o_tempor%C3%A1ria_de_contrato Cancelamento de suspensão temporária de contrato] |
| − | :*[ Desativação de contrato em degustação] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Desativa%C3%A7%C3%A3o_de_contrato_em_degusta%C3%A7%C3%A3o Desativação de contrato em degustação] |
| − | :*[ Desbloqueio de contrato] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Desbloqueio_de_contrato Desbloqueio de contrato] |
| − | :*[ Geração de contrato em html] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Gera%C3%A7%C3%A3o_de_contrato_em_html Geração de contrato em html] |
| − | :*[ Listagem de contratos em degustação] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Listagem_de_contratos_em_degusta%C3%A7%C3%A3o Listagem de contratos em degustação] |
| − | :*[ Suspensão temporária de contrato] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Suspens%C3%A3o_tempor%C3%A1ria_de_contrato Suspensão temporária de contrato] |
== Estoque == | == Estoque == | ||
| − | :*[ Alocação de equipamento em comodato] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Aloca%C3%A7%C3%A3o_de_equipamento_em_comodato Alocação de equipamento em comodato] |
| − | :*[ Cadastro de | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Cadastro_de_produtos Cadastro de produtos] |
| − | :*[ Cadastro de | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Cadastro_de_loca%C3%A7%C3%B5es_de_estoque Cadastro de locações de estoque] |
| − | :*[ Cadastro de | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Cadastro_de_modelos_de_produto Cadastro de modelos de produto] |
| − | :*[ Cadastro de tipos de produto] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Cadastro_de_tipos_de_produto Cadastro de tipos de produto] |
| − | :*[ Desativação de equipamento em comodato] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Desativa%C3%A7%C3%A3o_de_equipamento_em_comodato Desativação de equipamento em comodato] |
| − | :*[ Movimentação avulsa de estoque] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Movimenta%C3%A7%C3%A3o_avulsa_de_estoque Movimentação avulsa de estoque] |
== Financeiro == | == Financeiro == | ||
| − | :*[ Baixa de documento] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Baixa_de_documento Baixa de documento] |
| − | :*[ Cadastro de cartão de crédito/débito] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Cadastro_de_cart%C3%A3o_de_cr%C3%A9dito/d%C3%A9bito Cadastro de cartão de crédito/débito] |
| − | :*[ Cadastro de pré-faturamento] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Cadastro_de_pr%C3%A9-faturamento Cadastro de pré-faturamento] |
| − | :*[ Consulta documentos em aberto de clientes] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Consulta_documentos_em_aberto_de_clientes Consulta documentos em aberto de clientes] |
| − | :*[ Envio de aviso de pagamento] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Envio_de_aviso_de_pagamento Envio de aviso de pagamento] |
| − | :*[ Envio de boleto por e-mail] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Envio_de_boleto_por_e-mail Envio de boleto por e-mail] |
| − | :*[ Geração de linha digitável de boleto] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Gera%C3%A7%C3%A3o_de_linha_digit%C3%A1vel_de_boleto Geração de linha digitável de boleto] |
| − | :*[ Geração de link para download da fatura de serviços em pdf] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Gera%C3%A7%C3%A3o_de_link_para_download_da_fatura_de_servi%C3%A7os_em_pdf Geração de link para download da fatura de serviços em pdf] |
| − | :*[ Geração de link para download do boleto em pdf] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Gera%C3%A7%C3%A3o_de_link_para_download_do_boleto_em_pdf Geração de link para download do boleto em pdf] |
| + | :*[https://wiki.rbxsoft.com/wiki/index.php/Revers%C3%A3o_de_baixa Reversão de baixa] | ||
== Pedidos == | == Pedidos == | ||
| − | :*[ Encerramento de pedido] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Encerramento_de_pedido Encerramento de pedido] |
| − | :*[ Geração de contratos de pedido] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Gera%C3%A7%C3%A3o_de_contratos_de_pedido Geração de contratos de pedido] |
== Variados == | == Variados == | ||
| − | :*[ Alteração de campo complementar] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Altera%C3%A7%C3%A3o_de_campo_complementar Alteração de campo complementar] |
| − | :*[ Envio de sms avulso] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Envio_de_sms_avulso Envio de sms avulso] |
| − | :*[ Exclusão de campo complementar] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Exclus%C3%A3o_de_campo_complementar Exclusão de campo complementar] |
| − | :*[ Inclusão de campo complementar] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Inclus%C3%A3o_de_campo_complementar Inclusão de campo complementar] |
| − | :*[ Upload de arquivos] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Upload_de_arquivos Upload de arquivos] |
| − | :*[ Validação de acesso à Central do Assinante] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/Valida%C3%A7%C3%A3o_de_acesso_%C3%A0_Central_do_Assinante Validação de acesso à Central do Assinante] |
| − | :*[ TIP - Inclusão de conta] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/TIP_-_Inclus%C3%A3o_de_conta TIP - Inclusão de conta] |
| − | :*[ TIP - Alteração de conta] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/TIP_-_Altera%C3%A7%C3%A3o_de_conta TIP - Alteração de conta] |
| − | :*[ TIP - Exclusão de conta] | + | :*[https://wiki.rbxsoft.com/wiki/index.php/TIP_-_Exclus%C3%A3o_de_conta TIP - Exclusão de conta] |
Edição atual tal como às 11h03min de 4 de junho de 2021
Os web services descritos neste manual foram desenvolvidos no padrão REST + JSON. O endpoint de todos os serviços é:
https://[minha_url]/routerbox/ws_json/ws_json.php
O método utilizado para todos os serviços deve ser POST.
O nome do serviço é definido no corpo da mensagem.
A chave de integração deve ser enviada no cabeçalho da requisição, em um campo chamado authentication_key.
Estes web services requerem que o RBX 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 são listados os web services disponíveis a partir da versão 4.2 do sistema.
Atendimentos
Autenticações
Contatos
Contratos
- Alteração de contrato em degustação
- Assinatura de contrato
- Ativação de contrato
- Bloqueio de contrato
- Cadastro de contrato de degustação
- Cancelamento de contrato
- Cancelamento de suspensão temporária de contrato
- Desativação de contrato em degustação
- Desbloqueio de contrato
- Geração de contrato em html
- Listagem de contratos em degustação
- Suspensão temporária de contrato
Estoque
Financeiro
- Baixa de documento
- Cadastro de cartão de crédito/débito
- Cadastro de pré-faturamento
- Consulta documentos em aberto de clientes
- Envio de aviso de pagamento
- Envio de boleto por e-mail
- Geração de linha digitável de boleto
- Geração de link para download da fatura de serviços em pdf
- Geração de link para download do boleto em pdf
- Reversão de baixa
