Especificación de Servicios WEB de Consulta y Pagos del SOA



[pic]

Especificación de servicios WEB

de consulta y pagos del SOA

INS

[pic]

Contenido

Introducción 4

Esquema de Pagos 7

Definición de Elementos del Esquema 7

Definición de Elementos del Esquema 8

Análisis de las Fases y Procesos 10

Resumen de Formatos y Tramas XML 18

Estructuras de Bases de Datos Pagos Electrónicos INS 23

Introducción

Los servicios Web de consulta y pago del Seguro Obligatorio de Automóviles que ofrece el Instituto Nacional de Seguros, tienen como objetivo proporcionar las herramientas para que los entes recaudadores puedan realizar la consulta y el pago de los derechos de circulación vía Internet de forma segura y con tiempos de respuesta adecuados.

Generalidades.

Para la utilización de las herramientas de consulta y pago de los derechos de circulación por internet, el INS proporcionará tres servicios que deben ser utilizados por los recaudadores, los cuales se describen a continuación:

1. Consulta del vehículo: características, propietario, monto y rubros a cobrar en el derecho de circulación. El servicio a utilizar es: ConsultaSOAXml (string XmlInfoPlaca)

2. Generación del pago de los derechos de circulación: retorna un número de transacción el cual garantiza que el pago se realizó satisfactoriamente. El servicio a utilizar es: SolicitaPagoSOAXml (string XlmDatosPagador).

3. Actualización de los números de Comprobantes que los entes recaudadores utilizaron en la impresión de los derechos de circulación. El servicio a utilizar es: ActualizaSOAXml (string XmlDatosActualiza).

Debido a que la comunicación y transacciones de consulta y pago se deben realizar en un ambiente seguro, la invocación de los servicios y los resultados de los mismos deberán estar encriptados por un componente binario. El INS proporcionará el componente de encripción a los entes recaudadores para que puedan enviar e interpretar los mensajes.

El componente de Encripción se describe a continuación:

|Nombre |INSPagoSeguro.dll |

|Descripción |Encripta y Desencripta tramas XML, que se usan en consumo de los Servicios WEB. |

|Plataformas de Soporte|W2000, WXP con la versión del Framework de Microsoft |

| |.NET versión 1.1 o superior. |

|Métodos Públicos |EncriptarXml(string TramaXml) |

| |Encripta una trama XML que cumpla con el esquema del formato definido por el INS. |

| |Recibe: Trama XML |

| |Retorna: Trama Encriptada. |

| | |

| |DesEncriptarXml(string TramaXml) |

| |Desencripta una trama previamente encriptada por el componente: INSPagoSeguro.dll |

| |Recibe: Trama Encriptada |

| |Retorna: Trama XML. |

| | |

| |ObtenerNumTransaccion(string TramaXml) |

| |Método opcional, Obtiene el Número de Transacción de la trama XML de confirmación de un Pago previamente realizado en|

| |el SICSOA. |

| |Recibe: Trama Encriptada |

| |Retorna: Número de Transacción Formato String |

| | |

| |DesencriptarADisco(string TramaXml, string RutaArchivo) |

| |Método opcional, Crea un archivo XML en |

| |Disco con base en una trama XML Completa de Confirmación de pago previamente encriptada con el componente |

| |INSPagoSeguro.dll |

| |Recibe: Trama Encriptada, y Ruta del Directorio donde se desea crear el archivo. |

| |Nota: La ruta de especificación debe seguir el siguiente estándar \, o |

| |\\, |

| |Nótese que al final de la ruta No se especifican el símbolo “\” que el método lo asume. |

| |Retorna: Archivo XML de Confirmación en disco, Nota: el Directorio deberá tener los permisos de escritura básicos. |

| | |

Adicionalmente todas las tramas de comunicación entre los servicios deberán respetar un formato XML que el INS proporcionara para cada unos de los mensajes ya sea de invocación o de resultado.

Esquema de Pagos

Definición de Elementos del Esquema

|Elemento |Descripción |

| [pic] |Representa las Entidades Recaudadoras que utilizaran los servicios |

| |WEB |

| [pic] |Representa los procesos que deben realizar los Recaudadores, en |

| |este caso se interpreta como Proceso Recaudador 1. |

| |Los Procesos de Recaudador van desde el PR1, hasta el PR7. |

| [pic] |Representa la rutina de encripción que brinda el componente |

| |INSPagoSeguro.dll |

| [pic] |Representa la rutina de desencripción que brinda el componente |

| |INSPagoSeguro.dll |

|Trama_SOA_INFO_PLACA_XML |Representa la trama XML encriptada para la solicitud del servicio |

| |de consulta de la información de vehículos. |

|Trama(ERR)_SOA_EXCEPCION_XML |Representa la trama de errores de validación de archivos o |

| |cualquier otra excepción que valide el servicio WEB. |

|Trama_SOA_RESULT_PLACA_XML |Representa la trama XML encriptada con la información de la |

| |consulta de vehículos. |

|Trama_SOA_SOLIC_PAGO_PLACA_XML |Representa la trama XML encriptada con la información del pago por |

| |la cual se aplicará el pago en el SICSOA. |

|Trama_SOA_NUMTRANSACCION_XML |Representa la trama encriptada del resultado del número de |

| |transacción, posterior a aplicar el pago. |

|[pic] |Representa la Rutina de Impresión de Comprobantes del Pago de |

| |Seguro de Automóviles realizado por los recaudadores. |

|Tram_SOA_ACTUALIZA_COMPROBANTE_XML |Representa la trama XML encriptada con la información de los |

| |Números de los comprobantes asociados a las transacciones |

| |procesadas. |

|Trama_SOA_RESULT_ACTUALIZA_XML |Representa la trama XML encriptada con la información del resultado|

| |de la actualización del número de comprobantes. |

|[pic] |Representa el servidor Web donde residen los servicios Web de |

| |Consulta y Pago. |

|[pic] |Representa los procesos del servidor WEB, en este caso se presenta |

| |como Proceso Web1, los procesos del servidor Web van desde PW1 |

| |hasta PW6. |

|[pic] |Rutina de Validación y encripción del Servidor Web de servicios. |

|[pic] |Representa el Servidor de Base de Datos donde residen los datos y |

| |procesos almacenados del SICSOA. |

|[pic] |Representa los Procesos de Datos del Servidor de Base de Datos que |

| |se utilizan en los Servicios Web. Los procesos del Servidor van |

| |desde PD1 hasta el PD2. |

|[pic] |Representa el proceso de Consulta a nivel de Base de datos. |

|[pic] |Representa el proceso de Aplicación de los pagos en la base de |

| |datos del SICSOA |

|[pic] |Representa el proceso de actualización del número de comprobante |

| |asociado a cada número de transacción en el SICSOA. |

Análisis de las Fases y Procesos

|No |Fase |Descripción de Procesos |Elementos |

|1 |Consulta de |PR1 (Proceso Recaudador No. 1) |PR1 |

| |Información de|El recaudador captura los datos del vehículo para realizar la consulta del monto |INSPagoSeguro.dl |

| |la Placa. |a pagar, estos datos son: Clase de Placa, Número de Placa y Código de Gobierno. |PW1 |

| | |Nota el código de Gobierno es un valor por defecto que siempre deberá tener el |PW2 |

| | |valor de “PAR”. |PD1 |

| | |El recaudador crea la trama XML llamada SOA_INFO_PLACA, con la información del |PR2 |

| | |número de placa del vehículo, con el siguiente formato XML, donde el símbolo (?),|Tramas XML |

| | |representa el valor del elemento. | |

| | | | |

| | |? | |

| | |? | |

| | |? | |

| | | | |

| | | | |

| | |El recaudador procede a encriptar la trama XML por medio de componente | |

| | |INSPagoSeguro.dll. | |

| | |El recaudador procede a invocar el servicio WEB ConsultaSOAXml, pasando como | |

| | |parámetro la trama previamente encriptada. | |

| | |PW1 (Proceso Web No.1) | |

| | |El servicio Web desencripta la trama XML enviada por el Recaudador. | |

| | |El servicio Web valida el formato del archivo y que los elementos XML tengan su | |

| | |correspondiente valor. | |

| | |En caso de Error el Servicio retorna una trama XML indicando la excepción y error| |

| | |encontrados, en el siguiente formato, el símbolo (?) representa el valor del | |

| | |elemento. | |

| | | | |

| | | | |

| | | | |

| | | ? | |

| | | | |

| | | | |

| | | | |

| | | | |

| | |Si no se encuentra error el servicio invoca el proceso de consulta de la base da | |

| | |tos. | |

| | |PD1 (Proceso de Datos No. 1) | |

| | |El servicio de base de datos realiza la consulta del monto y rubros a cancelar y | |

| | |se los reenvía al servicio Web | |

| | |PW2 (Proceso Web No. 2) | |

| | |El servicio Web le da formato al resultado de la consulta para formar la trama | |

| | |XML SOA_RESULT_PLACA, con el siguiente formato, donde el símbolo (?), representa | |

| | |el valor del elemento. | |

| | | | |

| | | | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | | | |

| | | | |

| | | | |

| | |1 | |

| | |SEGURO OBLIGATORIO DE AUTOMOVILES | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | | | |

| | | | |

| | |Los rubros son variables con base en la placa del vehiculo) | |

| | | | |

| | |El servicio Web encripta la información de la trama XML y envía de vuelta al | |

| | |Recaudador | |

| | |PR2 (Proceso de Recaudador No. 2) | |

| | |El recaudador desencripta la trama XML y presenta o informa al pagador del monto | |

| | |y rubros pendientes de Pago. | |

|2 |Procesamiento |PR3 (Proceso Recaudador No. 3) |PR3 |

| |del Pago |El recaudador crea una trama XML, llamada SOA_SOLIC_PAGO_PLACA, con la |INSPagoSeguro.dl |

| |Electrónico |información del pagador basado en el siguiente formato, el símbolo (?) |PW3 |

| | |representa los valores de los elementos. |PW4 |

| | | |PD2 |

| | |? |PR4 |

| | |? |Tramas XML |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | |? | |

| | | | |

| | | | |

| | |El recaudador procede a encriptar la trama XML por medio de componente | |

| | |INSPagoSeguro.dll. | |

| | |El recaudador procede a invocar el servicio WEB SolicitaPagoSOAXml, pasando | |

| | |como parámetro la trama previamente encriptada. | |

| | |PW3 (Proceso Web No.3) | |

| | |El servicio Web desencripta la trama XML enviada por el Recaudador. | |

| | |El servicio Web valida el formato del archivo y que los elementos XML tenga un | |

| | |correspondiente valor. | |

| | |En caso de Error el Servicio retorna una trama XML indicando la excepción y | |

| | |error encontrados, en el siguiente formato, el símbolo (?) representa el valor| |

| | |de l elemento. | |

| | | | |

| | | | |

| | | | |

| | | ? | |

| | | | |

| | | | |

| | | | |

| | | | |

| | |Si no se encuentran error el servicio invoca el proceso de Aplicación del Pago | |

| | |en la Base de datos. | |

| | |PD2 (Proceso de Datos No. 2) | |

| | |El servicio de base de datos realiza la Aplicación del Pago en la base de datos| |

| | |del SICSOA. | |

| | |W4 (Proceso Web No. 4) | |

| | |El servicio Web formatea el resultado de la consulta para formar la trama | |

| | |SOA_NUMTRANSACCION, con el siguiente formato, donde el símbolo (?), representa | |

| | |el valor del elemento. | |

| | | | |

| | |? | |

| | |? | |

| | |? | |

| | | | |

| | | | |

| | |El servicio Web encripta la información de la trama XML y envía de vuelta al | |

| | |Recaudador | |

| | |PR4 (Proceso de Recaudador No. 4) | |

| | |El recaudador desencripta la trama XML y presenta o informa al recaudador el | |

| | |número de Transacción aplicado al SICSOA. El recaudador procede a realizar | |

| | |cualquier actualización a sus sistemas internos, en caso que aplique. | |

| | |PR5 (Proceso de Recaudador No. 5) | |

| | |Con la información confirmada del número de transacción, más el detalle de los | |

| | |rubros de pago el recaudador procederá a realizar la impresión del derecho de | |

| | |circulación | |

| | | | |

|No |Fase |Descripción de Procesos |Elementos |

|3 |Actualización de |PR6 (Proceso Recaudador No. 6) |PR6 |

| |Número de |El recaudador crea una trama XML con la información de los comprobantes |INSPagoSeguro.dl |

| |Comprobantes |impresos que poseen números de transacción asociadas, bajo el siguiente |PW5 |

| |Impresos al |formato: el símbolo (?) representa el valor del elemento XML |PW6 |

| |SICSOA. | |PD3 |

| | | |PR7 |

| | |? |Tramas XML |

| | |? | |

| | |? | |

| | |? | |

| | | | |

| | | | |

| | | | |

| | | | |

| | |PR7 (Proceso Recaudador No. 7) | |

| | |El recaudador procede a encriptar la trama XML por medio de componente | |

| | |INSPagoSeguro.dll. | |

| | |El recaudador procede a invocar el servicio WEB ActualizaSOAXml, pasando como| |

| | |parámetro la trama previamente encriptada. | |

| | |PW5 (Proceso Web No.5) | |

| | |El servicio Web desencripta la trama XML enviada por el Recaudador. | |

| | |El servicio Web valida el formato del archivo y que los elementos XML tenga | |

| | |un correspondiente valor. | |

| | |En caso de Error el Servicio retorna una trama XML indicando la excepción y | |

| | |error encontrados, en el siguiente formato, el símbolo (?) representa el | |

| | |valor de l elemento. | |

| | | | |

| | | | |

| | | | |

| | | ? | |

| | | | |

| | | | |

| | | | |

| | | | |

| | |Si no se encuentran error el servicio invoca el proceso de Actualización de | |

| | |comprobantes en la Base de datos. | |

| | |PD3 (Proceso de Datos No. 3) | |

| | |El servicio de base de datos realiza la Actualización de lo número de | |

| | |comprobantes en la Base de Datos del SICSOA. | |

| | |PW6 (Proceso Web No. 6) | |

| | |El servicio Web formatea el resultado de la actualización para formar la | |

| | |trama SOA_RESULT_ACTUALIZA, con el siguiente formato, donde el símbolo (?), | |

| | |representa el valor del elemento. | |

| | | | |

| | | | |

| | |? | |

| | |? | |

| | | | |

| | | | |

| | |? | |

| | |? | |

| | | | |

| | | | |

| | | | |

| | |El servicio Web encripta la información de la trama XML y se envía de vuelta | |

| | |al Recaudador | |

| | |El recaudador desencritará y revisará la información y determinará los | |

| | |errores encontrados, deberá reenviar la actualización de los comprobantes que| |

| | |han reportado error repitiendo el proceso, PR6 y PR7. | |

Resumen de Formatos y Tramas XML

1. Trama XML : Solicitud de Información de Placa y Rubros.

?

?

?

Nota: el signo (?), representa el valor del Elemento XML.

2. Trama XML, Resultado de la Información de la Placa y Rubros.

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

1

SEGURO OBLIGATORIO DE AUTOMOVILES

?

?

?

?

2

RECARGOS DEL SEGURO OBLIGATORIO

?

?

?

?

3

APORTE AL CONSEJO DE SEGURIDAD VIAL

?

?

?

?

4

RECARGO DEL APORTE DE SEGURIDAD VIAL

?

?

?

?

5

IMPUESTO A LA PROPIEDAD DE VEHICULOS

?

?

?

?

6

RECARGO IMPUESTO DE LA PROPIEDAD

?

?

?

?

10

ESTACIONOMETROS (PARQUIMETROS)

?

?

?

?

11

RECARGO DE INTERESES POR ESTACIONOMETROS

?

?

?

?

12

IMPUESTO A FAVOR DE LAS MUNICIPALIDADES

?

?

?

?

13

TIMBRE FAUNA SILVESTRE

?

?

?

?

14

LEY 7088 Y REF.

?

?

?

?

22

IMPUESTO DE VENTAS (13%)

?

?

?

?

Nota: el signo (?), representa el valor del Elemento XML.

Los códigos de rubros pueden variar con base en al número de placa.

3. Trama XML, : Solicitud de Confirmación del Pago.

?

?

?

?

?

?

?

?

?

Nota: el signo (?), representa el valor del Elemento XML.

4. Trama XML, : Confirmación del Número de Transacción.

?

?

?

Nota: el signo (?), representa el valor del Elemento XML.

5. Trama XML, : Actualización Números de Comprobantes.

?

?

?

?

?

?

?

?

?

?

?

?

?

?

…..

Nota: el signo (?), representa el valor del Elemento XML.

6. Trama XML, : Resultado de la Actualización de Comprobantes en el SICSOA.

?

?

?

?

Estructuras de Bases de Datos Pagos Electrónicos INS

|TAA_CONSINTERNET |

|Descripción: Registra la placa con un identificador generado para la consulta. |

|Columna |Tipo de Dato |Descripción |

|IP |VARCHAR2(12) |Identificador de la Consulta |

|CLASEPLACA |VARCHAR2(4) |Clase de Placa |

|NUMPLACA |NUMBER(8) |Número de Placa |

|CODGOBIERNO |VARCHAR2(3) |Código de Gobierno |

|FECHA |DATE |Fecha de la Consulta |

|PERIODO |VARCHAR(4) |Periodo de la Consulta |

|TAA_RESINTERNET |

|Descripción: Registro de la Información del Pago. |

|Columna |Tipo de Dato |Descripción |

|IP |VARCHAR2(15) |Identificador de la Consulta |

|MONTO |NUMBER(16,2) |Monto total a Pagar |

|CODRES |NUMBER(1) |Resultado de la Consulta |

|ECOREV |VARCHAR2(1) |Indicador de Revisión Técnica |

|CEDPERSONAPROPIETARIO |VARCHAR2(15) |Cédula del Propietario del Vehiculo |

|NOMPERSONAPROPIETARIO |VARCHAR2(50) |Nombre del propietario del vehiculo |

|DESMARCA |VARCHAR2(30) |Descripción de la Marca del vehiculo |

|ANOMODELO |NUMBER(4) |Modelo del Vehiculo |

|ANOSADEUDADOS |NUMBER(2) |Años Adeudados |

|CODGRUPO |NUMBER(4) |Código del Grupo. |

|FECIVPOLIZA |DATE | |

|FECFVPOLIZA |DATE | |

|DESESTILO |VARCHAR2(30) |Descripción del Estilo del Vehiculo |

|CAPACIDAD |NUMBER(3) |Capacidad del Vehiculo |

|NUMCHASIS |VARCHAR2(30) |Número de Chasis |

|VALORFISCAL |NUMBER(16) |Valor Fiscal |

|NUMMOTOR |VARCHAR2(30) |Número de Motos |

|NUMCLASE |NUMBER(7) |Número de Clase |

|CEDPERSONAPAGADOR |VARCHAR2(15) |Cédula del Pagador |

|NOMPERSONAPAGADOR |VARCHAR2(50) |Nombre del Pagador |

|PROVINCIAPAGADOR |NUMBER(2) |Provincia del Pagador |

|CANTONPAGADOR |NUMBER(2) |Cantón del Pagador |

|DISTRITOPAGADOR |NUMBER(2) |Distrito del Pagador |

|NUMCAJA |NUMBER(4) |Número de Caja |

|TIPCAJA |NUMBER(2) |Tipo de Caja |

|CODRECAUDADOR |NUMBER(4) |Código de Recaudador |

|NUMCOMPROBANTE |NUMBER(8) |Número de Comprobante |

|NUMTRANSACCION |NUMBER(8) |Número de Transacción |

|DESRECAUDADOR |VARCHAR2(50) |Descripción del Recaudador |

|TAA_RUBROSINTERNET |

|Descripción: Información de los Rubros de Pago. |

|Columna |Tipo de Dato |Descripción |

|IP |VARCHAR2(12) |Identificador de la Consulta |

|CODRUBROPAGO |NUMERICO(3) |Código del Rubro de Pago |

|DESRUBRO |CARÁCTER(50) |Descripción del Rubro de Pago |

|MONANTERIOR |NUMERICO(14,2) |Monto Anterior del Rubro |

|MONACTUAL |NUMERICO(14,2) |Monto Actual del rubro |

|MONAJUSTES |NUMERICO(14,2) |Monto de Ajuste del Rubro |

-----------------------

FASE 1

FASE 1

Consulta de Información de la Placa

FASE 2

Procesamiento del Pago Electrónico

FASE 3

Actualización de Número de Comprobantes Impresos al SICSOA.

................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download