Mudanças entre as edições de "Web Services"
De RBX ISP - Manual do Usuário
Linha 66: | Linha 66: | ||
== 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 == |
Edição das 10h48min 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
Pedidos
Variados
- [ Alteração de campo complementar]
- [ Envio de sms avulso]
- [ Exclusão de campo complementar]
- [ Inclusão de campo complementar]
- [ Upload de arquivos]
- [ Validação de acesso à Central do Assinante]
- [ TIP - Inclusão de conta]
- [ TIP - Alteração de conta]
- [ TIP - Exclusão de conta]