Mudanças entre as edições de "Web Services"

De RBX ISP - Manual do Usuário
Linha 54: Linha 54:
  
 
== 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 ==

Edição das 10h22min 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

Estoque

Financeiro

Pedidos

  • [ Encerramento de pedido]
  • [ Geração de contratos de pedido]

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]