Guía de Interfaz con Oriens

Esta guía describe el proceso por el cual Oriens envía datos de un Servicio/Tarea finalizado (incluyendo información de carátula y formularios asociados) a un Web Service externo de un tercero.

Setup

Paso 1

1. Solicitar acceso de “Desarrollador” a tu ejecutivo de Oriens.

2. Asegurarse tener acceso a la pantalla Usuarios y Parámetros > Configuración Adicional en Oriens.

Paso 2

1. Configurar en Configuración Adicional la siguiente información:

   • Webservice URL de Servicios

2. Y se debe configurar 1 de los siguientes:

   • Usuario Webservice y Password para Webservice

   • Token en el parámetro “Se Envía Authorization y Key en Header para Webservice”

Paso 3

1. Ingresar a la forma de un Servicio en el portal.

2. Dar click en el Botón “Consumir WS”

   • Al dar click en este botón, se envía la información de ese servicio a la URL indicada anteriormente.

Flujo Básico

Servicio Oriens Finalizado $\rightarrow$ Usuario Clic en "Consumir WS" $\rightarrow$ Oriens Envía JSON a URL Externa $\rightarrow$ Sistema Externo Responde con Código.

El click en Consumir WS es para probar el servicio, pero se puede automatizar con las condiciones que se requieran.

Parámetros del Servicio

El servicio que estaríamos consumiendo sería del tipo REST y esperaría por parámetro un String de nombre “Servicio”.

Campo Json	Descripción
Servicio	Objeto raíz que contiene todos los datos del servicio.
User	Nombre de usuario configurado en Oriens
Password	Contraseña configurada en Oriens
Carátula	Array que contiene información detallada de la operación de servicio.
Forma	Array que contiene los campos y valores de la captura de los operadores.

A continuación un ejemplo del JSON que estaría recibiendo:

{

  "servicio" : {

 "user" : "oriens",

 "password" : "Pcjv3{Xt)Q",

 "caratula" : [ {

   "parametro" : "fechaEnCamino",

   "valor" : "07/08/2017 17:47:52"

 }, {

   "parametro" : "fechaCheckin",

   "valor" : "07/08/2017 17:57:52"

 }, {

   "parametro" : "fechaCheckout",

   "valor" : "07/08/2017 18:22:51"

 }, {

   "parametro" : "tiempoAtencion",

   "valor" : "Dos horas veintitres minutos"

 }, {

   "parametro" : "operadorNombre",

   "valor" : "John Smith"

 }, {

   "parametro" : "pdiLatitud",

   "valor" : "25.6857484"

 }, {

   "parametro" : "pdiLongitud",

   "valor" : "-100.32871090000003"

 }, {

   "parametro" : "servicioFolioCliente",

   "valor" : "123456-001"

 }, {

   "parametro" : "tipoServicio",

   "valor" : "Preventivo"

 }, {

   "parametro" : "agregadoFecha",

   "valor" : "06/08/2017 00:47:52"

 }, {

   "parametro" : "clienteNombre",

   "valor" : "Cliente Feliz"

 }, {

   "parametro" : "pdiIdInterno",

   "valor" : "12345"

 }, {

   "parametro" : "pdiNombre",

   "valor" : "Juan Perez Lopez"

 } ],

 "formas" : [ {

   "formaNombre" : "PERFIL DE CAMPO",

   "lstCampos" : [ {

     "tipoCampoId" : 1,

     "etiquetaCampo" : "Nombre del que atiende",

     "valorCampo" : "Juan Perez Lopez",

     "orden" : 1,

     "agregadoFechaMovil" : "2017-09-07"

   }, {

     "tipoCampoId" : 2,

     "etiquetaCampo" : "Telefono de contacto",

     "valorCampo" : "8114445555",

     "orden" : 2,

     "agregadoFechaMovil" : "2017-09-07"

   }, {

     "tipoCampoId" : 3,

     "etiquetaCampo" : "Fecha promesa",

     "valorCampo" : "17/09/2017",

     "orden" : 3,

     "agregadoFechaMovil" : "2017-09-07"

   }, {

     "tipoCampoId" : 4,

     "etiquetaCampo" : "Comentarios",

     "valorCampo" : "El cliente se puso agresivo, pero se le explco lo sucedido y guardo la calma",

     "orden" : 4,

     "agregadoFechaMovil" : "2017-09-07"

   }, {

     "tipoCampoId" : 5,

     "etiquetaCampo" : "Fotografía de la vivienda",

     "valorCampo" : "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsK",

     "orden" : 5,

     "agregadoFechaMovil" : "2017-09-07"

   }, {

     "tipoCampoId" : 6,

     "etiquetaCampo" : "Firma del actuario",

     "valorCampo" : "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsK",

     "orden" : 6,

     "agregadoFechaMovil" : "2017-09-07"

   }, {

     "tipoCampoId" : 10,

       "etiquetaCampo" : "El cliente desea mas tiempo",

     "valorCampo" : "1",

     "orden" : 7,

     "agregadoFechaMovil" : "2017-09-07"

   }, {

     "tipoCampoId" : 11,

     "etiquetaCampo" : "Codigo de barras del equipo",

     "valorCampo" : "5465465465465",

     "orden" : 8,

     "agregadoFechaMovil" : "2017-09-07"

   }, {

     "tipoCampoId" : 12,

     "etiquetaCampo" : "El equipo presenta daños?",

     "valorCampo" : "1",

     "orden" : 9,

     "agregadoFechaMovil" : "2017-09-07"

   } ]

 }, {

   "formaNombre" : "PERFIL LLAMADA",

   "lstCampos" : [ {

     "tipoCampoId" : 1,

     "etiquetaCampo" : "Nombre del que atiende",

     "valorCampo" : "Juan Perez Lopez",

     "orden" : 1,

     "agregadoFechaMovil" : "2017-09-07"

   }, {

     "tipoCampoId" : 2,

     "etiquetaCampo" : "Telefono de referencia",

     "valorCampo" : "814445555",

     "orden" : 2,

     "agregadoFechaMovil" : "2017-09-07"

   }, {

     "tipoCampoId" : 3,

     "etiquetaCampo" : "Fecha promesa de pago",

     "valorCampo" : "17/09/2017",

     "orden" : 3,

     "agregadoFechaMovil" : "2017-09-07"

   }, {

     "tipoCampoId" : 4,

     "etiquetaCampo" : "Comentarios",

     "valorCampo" : "Comentario 2",

     "orden" : 4,

     "agregadoFechaMovil" : "2017-09-07"

   } ]

 } ]

  }

}

Respuesta Esperada

Como respuesta estaríamos esperando:

{ "response" : { "code" : "0001" }}

Donde 0001 indicaría que todo fue exitoso y 9001 indicaría que ocurrió un error al procesarse y Oriens deberá reintentar durante el proceso nocturno el reenvío de la información.

Nota: Si no se responde con estos códigos, no se realizará exitosamente el envío.

Configuración del Web Service Saliente en Oriens

Accessible desde la pantalla Usuarios y Parámetros - Configuración Adicional

Campo de Configuración	Valor de Ejemplo	Propósito y Explicación
URL WEBSERVICE DE SERVICIOS	HTTP://WS.PRUEBA.ORIENS.COM.MX (Ejemplo)	Define el destino. Debe ingresar la URL completa (Endpoint) a la que Oriens debe enviar el JSON con los datos del servicio. Este debe ser el endpoint de su sistema que está listo para recibir el POST de tipo REST.
USUARIO WEBSERVICE	USUARIOWS (Ejemplo)	Opción 1 de Autenticación (Usuario/Contraseña). Este usuario se enviará en el cuerpo del JSON (dentro del objeto servicio) para que usted pueda validar la fuente de la petición.
PASSWORD PARA WEBSERVICE	PASSWORD (Ejemplo)	Opción 1 de Autenticación (Usuario/Contraseña). La contraseña asociada al usuario, también enviada en el cuerpo del JSON para su validación.
SE ENVIA AUTHORIZATION Y KEY EN HEADER PARA WEBSERVICE	TOKEN (Ejemplo)	Opción 2 de Autenticación (Header Token). Si su Web Service requiere un Token de seguridad en el encabezado HTTP (Header) en lugar de Usuario/Contraseña en el cuerpo, usted debe ingresar aquí el valor de dicho Token. Oriens enviará el Token en un Header específico para su validación.