Web Service Format
Web Service Format
Web Service Format
Electrodunas chatbot
STARTER
2021
1
ÍNDICE
ÍNDICE 2
Resumen 3
Estandarización 3
Cambios 3
Observaciones 4
Pendientes 4
Pág 2
1. RESUMEN
Estandarización
Se recomienda que los siguientes servicios:
Pág 3
Cambios
Observaciones
● Los servicios 5.4 “ValidarPotencialFise”, 5.5 “ValidarAgenteFise” y 5.6
“ValidarAgenteFise” no se están incluyendo en esta versión del chatBot
● 5.14 el servicio “DescargarPDF” no trae rutas, intentamos con el NIS del ejemplo y
los de prueba. Tampoco nos trae información usando Fiddler.
● 5.16 el servicio “DatosBasicosNIS” nos devuelve los datos que faltan como “null”,
recomendamos que nos lo envíen como cadena de texto vacía ya que esta
información va a ser vista por los usuarios.
Pág 4
Pendientes
● Quedan pendientes las credenciales de acceso.
● 5.12 Registro de Avisos en SGD / sigue pendiente ya que es depende de un tercero.
● 5.13 Enviar email / pendiente de corrección.
Pág 5
2. OBSERVACIÓN DEL CERTIFICADO SSL
Al momento de hacer una solicitud a los web services , esta responde un error SSL : “Unable to verify
the first certificate” que podría deberse a la falta de una de las configuraciones del certificado
intermedio de los web services.
Esta observación ocurre en todo los web services usados para el consumo desde el chatBot
Respuesta de la Prueba:
Posible Causa :
Pág 6
Referencia: https://qastack.mx/programming/31673587/error-unable-to-verify-the-first-certificate-in-nodejs
Pág 7
3. DEFINICIÓN DE LOS WEBSERVICES
Descripción Funcional:
Permite realizar la consulta del Número del Suministro de un Cliente, en función de los parámetros de entrada
Se enviará una estructura de datos en formato JSON con un solo atributo. Este atributo tiene el nombre NIS y
sus características se detallan a continuación:
Nombre: NIS
Descripción Número de Suministro que es el identificador del Cliente en el Sistema
Comercial
Tipo Cadena de texto
Longitud 9 caracteres
Valores Sólo contiene caracteres numéricos
Se enviará una estructura de datos en formato JSON con los siguientes atributos: terminoBien, err_msg,
mensaje. Estos atributos y sus características se detallan a continuación:
Ruta https://aplicacionesdev.electrodunas.com/ChatBotWeb/
Método POST
Llamada del Método https://aplicacionesdev.electrodunas.com/ChatBotWeb/api/ChatBot/ValidarNroSuministro
Cabecera User-Agent: Fiddler
Content-type: application/json; charset=utf-8
Host: aplicacionesdev.electrodunas.com
Content-Length: 25
Dato de Pruebas "NIS": "101002607"
Ejemplo de solicitud:
{
"NIS": "101002607"
}
Pág 8
Ejemplo de Resultado de la Ejecución
{
"terminoBien": 1,
"err_msg": "",
"mensaje": "El NIS es válido"
}
{
"terminoBien": 0,
"err_msg": "El NIS no está registrado en el sistema",
"mensaje": ""
}
{
“terminoBien”: 0,
“err_msg”: "Hubo un error interno en el sistema",
“mensaje”: ""
}
Pág 9
5.2 SERVICIO WEB “MontoVencimientoUltRecibo”
Descripción Funcional:
Permite realizar la consulta del monto y vencimiento del último recibo del Suministro de un Cliente, en función
de los parámetros de entrada
Se enviará una estructura de datos en formato JSON con un solo atributo. Este atributo tiene el nombre NIS y
sus características se detallan a continuación:
Nombre: NIS
Descripción Número de Suministro que es el identificador del Cliente en el Sistema
Comercial
Tipo Cadena de texto
Longitud 9 caracteres
Valores Sólo contiene caracteres numéricos
Se enviará una estructura de datos en formato JSON con los siguientes atributos: terminoBien, err_msg,
mensaje. Estos atributos y sus características se detallan a continuación:
Ruta https://aplicacionesdev.electrodunas.com/ChatBotWeb/
Método POST
Llamada del Método https://aplicacionesdev.electrodunas.com/ChatBotWeb/api/ChatBot/MontoVencimientoUltRecibo
Ejemplo de solicitud:
Pág 10
{
"NIS": "101002607"
}
Actualmente nos el servicio da esta respuesta
Resultado:
{
"terminoBien": 1,
"err_msg": "",
"mensaje": "el saldo actual de tu recibo 32166744 es S/40.20 con fecha de vencimiento 06/08/21"
}
{
"terminoBien": 0,
"err_msg": "Su recibo está pendiente de emisión",
"mensaje": ""
}
{
“terminoBien”: 0,
“err_msg”: "Hubo un error interno en el sistema",
“mensaje”: ""
}
Pág 11
5.3 SERVICIO WEB “FechaCorte”
Descripción Funcional:
Permite realizar la consulta de la fecha de corte aplicado al Suministro de un Cliente, en función de los
parámetros de entrada
Se enviará una estructura de datos en formato JSON con un solo atributo. Este atributo tiene el nombre NIS y
sus características se detallan a continuación:
Nombre: NIS
Descripción Número de Suministro que es el identificador del Cliente en el Sistema
Comercial
Tipo Cadena de texto
Longitud 9 caracteres
Valores Sólo contiene caracteres numéricos
Se enviará una estructura de datos en formato JSON con los siguientes atributos: terminoBien, err_msg,
mensaje. Estos atributos y sus características se detallan a continuación:
Ruta https://aplicacionesdev.electrodunas.com/ChatBotWeb/
Método POST
Llamada del Método https://aplicacionesdev.electrodunas.com/ChatBotWeb/api/ChatBot/FechaCorte
Ejemplo de solicitud:
{
"NIS": "101002607"
}
Pág 12
Actualmente nos el servicio da esta respuesta
Resultado:
{
"terminoBien": 1,
"err_msg": "",
"mensaje": "Estimado cliente su suministro N° 101002607 tiene fecha de corte: 09/06/21"
}
{
"terminoBien": 0,
"err_msg": "Estimado cliente su suministro aún no tiene fecha de corte. Gracias",
"mensaje": ""
}
{
"terminoBien": 0,
"err_msg": "Hubo un error interno en el sistema",
"mensaje": ""
}
Pág 13
5.7 SERVICIO WEB “ValidarEventoRed”
Descripción Funcional: Permite realizar la consulta y validación si un Suministro está comprendido dentro de
una Interrupción o Evento en la Red Eléctrica, en función de los parámetros de entrada
Nombre: NIS
Descripción Número de Suministro que es el identificador del Cliente en el Sistema
Comercial
Tipo Cadena de texto
Longitud 9 caracteres
Valores Sólo contiene caracteres numéricos
Ruta https://aplicacionesdev.electrodunas.com/ChatBotWeb/
Método POST
Llamada del Método https://aplicacionesdev.electrodunas.com/ChatBotWeb/api/ChatBot/ValidarEventoRed
Ejemplo de solicitud:
{
"NIS": "401011270"
}
Pág 14
Recomendamos esta nueva estructura
{
"terminoBien": 1,
"err_msg": "",
"mensaje": "Su suministro no cuenta con energía, por una Interrupción Imprevista, desde 18:51 hasta 22:31
ocasionado por Intervenci¢n en Suministro"
}
{
"terminoBien": 0,
"err_msg": "En estos momentos su suministro debe tener energía eléctrica. Gracias.",
"mensaje": ""
}
{
"terminoBien": 0,
"err_msg": "Hubo un error interno en el sistema",
"mensaje": ""
}
Descripción Funcional: Permite realizar la consulta del Estado actual del Suministro en el Sistema Comercial, en
función de los parámetros de entrada
Pág 15
Nombre: NIS
Descripción Número de Suministro que es el identificador del Cliente en el Sistema
Comercial
Tipo Cadena de texto
Longitud 9 caracteres
Valores Sólo contiene caracteres numéricos
Ruta https://aplicacionesdev.electrodunas.com/ChatBotWeb/
Método POST
Llamada del Método https://aplicacionesdev.electrodunas.com/ChatBotWeb/api/ChatBot/ValidarEstadoNIS
Ejemplo de solicitud:
{
"NIS": "101002607"
}
Pág 16
{
"terminoBien": 1,
"err_msg": "",
"mensaje": "Estimado Cliente su Solicitud está siendo procesada y su Suministro N° 101002607 se
encuentra en el estado de: Suspendido por Impago"
}
{
"terminoBien": 0,
"err_msg": "Estimado Clientes Usted no tiene una Solicitud para procesar. Gracias.",
"mensaje": ""
}
{
"terminoBien": 0,
"err_msg": "Hubo un error interno en el sistema",
"mensaje": ""
}
Descripción Funcional: Permite realizar la consulta del Estado de la Solicitud de un Nuevo Suministro en el
Sistema Comercial realizada por un Cliente, en función de los parámetros de entrada
Se enviará una estructura de datos en formato JSON con un solo atributo. Este atributo tiene el nombre NIS y
sus características se detallan a continuación:
Nombre: NIS
Descripción Número de Suministro que es el identificador del Cliente en el Sistema
Comercial
Tipo Cadena de texto
Longitud 9 caracteres
Valores Sólo contiene caracteres numéricos
Se enviará una estructura de datos en formato JSON con los siguientes atributos: terminoBien, err_msg,
mensaje. Estos atributos y sus características se detallan a continuación:
Pág 17
Nombre Tipo Longitud Valores Descripción
terminoBien Entero 1 0o1 Flag que indica que la consulta fue
satisfactoria o no.
err_msg Cadena 250 cadena de texto Mensaje que emite el método cuando se ha
alfanumérico retornado una respuesta exitosa.
mensaje Cadena 250 cadena de texto Mensaje cuando el método cuando se ha
alfanumérico retornado una respuesta exitosa.
Ruta https://aplicacionesdev.electrodunas.com/ChatBotWeb/
Método POST
Llamada del Método https://aplicacionesdev.electrodunas.com/ChatBotWeb/api/ChatBot/ValidarSolicitudNuevoNIS
Ejemplo de solicitud:
{
"NIS": "101002607"
}
Pág 18
"terminoBien": 1,
"err_msg": "",
"mensaje": "Estimado Cliente su Solicitud está siendo procesada y su Suministro N° 700086618 se
encuentra en el estado de: Pendiente de Conexión"
}
{
"terminoBien": 0,
"err_msg": "Estimado Clientes Usted no tiene una Solicitud de Nuevo Suministro. Gracias.",
"mensaje": ""
}
{
"terminoBien": 0,
"err_msg": "Hubo un error interno en el sistema",
"mensaje": ""
}
Nombre: NIS
Descripción Número de Suministro que es el identificador del Cliente en el Sistema
Comercial
Tipo Cadena de texto
Longitud 9 caracteres
Valores Sólo contiene caracteres numéricos
Pág 19
Punto de Enlace para el Esquema del Servicio:
Ruta https://aplicacionesdev.electrodunas.com/ChatBotWeb/
Método POST
Llamada del Método https://aplicacionesdev.electrodunas.com/ChatBotWeb/api/ChatBot/ValidarConsumoEnergiaNIS
Ejemplo de solicitud:
{
"NIS": "101002607"
}
Resultado:
{
"terminoBien": 1,
"err_msg": "",
"mensaje": "Estimado Cliente, el consumo en Kwh es 23 y el consumo en Soles es 40,2"
}
Pág 20
"terminoBien": 0,
"err_msg": "Estimado Clientes Usted no tiene consumo en el presente mes. Gracias.",
"mensaje": ""
}
{
"terminoBien": 0,
"err_msg": "Hubo un error interno en el sistema",
"mensaje": ""
}
Descripción Funcional: Permite realizar la consulta de la deuda y cantidad de recibos que no paga por el
servicio de energía eléctrica de un Nuevo Suministro del Cliente en el Sistema Comercial, en función de los
parámetros de entrada
Nombre: NIS
Descripción Número de Suministro que es el identificador del Cliente en el Sistema
Comercial
Tipo Cadena de texto
Longitud 9 caracteres
Valores Sólo contiene caracteres numéricos
Ruta https://aplicacionesdev.electrodunas.com/ChatBotWeb/
Método POST
Llamada del Método https://aplicacionesdev.electrodunas.com/ChatBotWeb/api/ChatBot/ValidarCantidadDeudaMesesNIS
Pág 21
{
"NIS": "101002607"
}
{
"terminoBien": 1,
"err_msg": "",
"mensaje": "Estimado Cliente, el monto de su Deuda es de S/461.00 y la cantidad de meses que adeuda es
de 9 meses"
}
{
"terminoBien": 0,
"err_msg": "Estimado Clientes Usted no tiene deuda pendiente. Gracias.",
"mensaje": ""
}
{
"terminoBien": 0,
"err_msg": "Hubo un error interno en el sistema",
"mensaje": ""
}
Pág 22
5.14 SERVICIO WEB “DescargarPDF”
Descripción Funcional:
Permite obtener la ruta donde se encuentra el último recibo de un Cliente a través de los parámetros de
Entrada.
Nombre: NIS
Descripción Número de Suministro que es el identificador del Cliente en el Sistema
Comercial
Tipo Cadena de texto
Longitud 9 caracteres
Valores Sólo contiene caracteres numéricos
Ruta https://aplicacionesdev.electrodunas.com/ChatBotWeb/
Método POST
Llamada del Método https://aplicacionesdev.electrodunas.com/ChatBotWeb/api/ChatBot/DescargarPDF
Ejemplo de solicitud:
{
"NIS": "101002607"
}
Pág 23
Resultado:
{
"terminoBien": 1,
"err_msg": "",
"ruta": "https://www.electrodunas.com/Recibos/101002767.pdf"
}
{
"terminoBien": 0,
"err_msg": "Usted aún no tiene recibos emitidos.",
"ruta": ""
}
{
"terminoBien": 0,
"err_msg": "Hubo un error interno en el sistema",
"ruta": ""
}
Pág 24
5.15 SERVICIO WEB “VerLecturas”
Descripción Funcional:
Permite obtener la ruta donde se encuentra la lectura actual y anterior de un Suministro a través de los
parámetros de Entrada.
Nombre: NIS
Descripción Número de Suministro que es el identificador del Cliente en el Sistema
Comercial
Tipo Cadena de texto
Longitud 9 caracteres
Valores Sólo contiene caracteres numéricos
Se enviará una estructura de datos en formato JSON con los siguientes atributos: terminoBien, err_msg, ruta.
Estos atributos y sus características se detallan a continuación:
Ruta https://aplicacionesdev.electrodunas.com/ChatBotWeb/
Método POST
Llamada del Método https://aplicacionesdev.electrodunas.com/ChatBotWeb/api/ChatBot/VerLecturas
Ejemplo de solicitud:
{
"NIS": "101002607"
}
Pág 25
Recomendamos esta nueva estructura
{
"terminoBien": 1,
"err_msg": "",
"ruta": "https://www.electrodunas.com/UltimasLecturas/10100276732153970.pdf"
}
{
"terminoBien": 0,
"err_msg": "Usted aún no tiene lecturas emitidas.",
"ruta": ""
}
{
"terminoBien": 0,
"err_msg": "Hubo un error interno en el sistema",
"ruta": ""
}
Descripción Funcional: Permite obtener los datos Básicos de un Cliente que tiene un Suministro a través de los
parámetros de Entrada.
Pág 26
Se enviará una estructura de datos en formato JSON con un solo atributo. Este atributo tiene el nombre NIS y
sus características se detallan a continuación:
Nombre: NIS
Descripción Número de Suministro que es el identificador del Cliente en el Sistema
Comercial
Tipo Cadena de texto
Longitud 9 caracteres
Valores Sólo contiene caracteres numéricos
Datos de salida :
Pág 27
Ruta https://aplicacionesdev.electrodunas.com/ChatBotWeb/
Método POST
Llamada del Método https://aplicacionesdev.electrodunas.com/ChatBotWeb/api/ChatBot/DatosBasicosNIS
Cabecera User-Agent: Fiddler
Content-type: application/json; charset=utf-8
Host: aplicacionesdev.electrodunas.com
Content-Length: 25
Dato de Pruebas "NIS":"101002767"
Ejemplo de solicitud:
{
"NIS": "101002767"
}
Resultado:
{
"Nombres": "JUANA VILMA",
"ApellidoPaterno": "VENTE",
"ApellidoMaterno": "DE COLINA",
"Telefono": "null",
"Email": "mercegsc91@gmail.com",
"Tarifa": "BT5BR",
"TipoDocumento": "DNI",
"NroDocumento": "21420194",
"FaltaDatoCell": 0,
"FaltaDatoEmail": 1,
"FaltaDatoTDoc": 1,
Pág 28
"FaltaDatoDoc": 1,
"terminoBien": 1,
"mensaje": "Los datos del Cliente han sido hallados en el Sistema Comercial."
}
{
"Nombres": "",
"ApellidoPaterno": "",
"ApellidoMaterno": "",
"Telefono": "",
"Email": "",
"TipoDocumento": "",
"NroDocumento": "",
"FaltaDatoCell": 0,
"FaltaDatoEmail": 0,
"FaltaDatoTDoc": 0,
"FaltaDatoDoc": 0,
"terminoBien": 0,
"mensaje": "No se encontraron datos del cliente."
}
{
"Nombres": "",
"ApellidoPaterno": "",
"ApellidoMaterno": "",
"Telefono": "",
"Email": "",
"TipoDocumento": "",
"NroDocumento": "",
"FaltaDatoCell": 0,
"FaltaDatoEmail": 0,
"FaltaDatoTDoc": 0,
"FaltaDatoDoc": 0,
"terminoBien": 0,
"mensaje": "Hubo un error en el sistema."
}
Pág 29