Interface Guide with Oriens (English Version)

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

Step 1

1. Request Developer access from your Oriens account executive.

2. Make sure you have access to the screen Users and Parameters > Additional Configuration in Oriens.

Step 2

1. In Additional Configuration, set the following information:

   • Services Webservice URL: With your webhook

2. You must configure one of the following authentication methods:

   • Webservice User and Webservice Password

   • Token (using the parameter: “Authorization and Key are sent in the Webservice Header”)

Step 3

1. Open a Service form in the portal.

2. Click the “Consume WS” button:

   • When clicked, the service information is sent to the URL configured previously.

Basic Flow

Oriens Service Completed → User clicks “Consume WS” → Oriens sends JSON to external URL → External system responds with a code

Clicking Consume WS is intended for testing the service, but this process can be automated based on the required conditions.

Service Parameters

The service being consumed is REST-based and expects a string parameter named “servicio”.

Fields in the Received JSON

JSON Field	Description
Servicio	Root object containing all service data.
User	Username configured in Oriens.
Password	Password configured in Oriens.
Carátula	Array containing detailed information about the service operation.
Forma	Array with the fields and values captured by operators.

This is an example of the JSON you will be receiving:

{

  "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"

   } ]

 } ]

  }

}

Expected Response

The response returned by the external system must have the following structure:

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

Where:

• 0001 = Success

• 9001 = Processing error (Oriens will retry during the nightly batch process)

Note: If these codes are not returned, the submission will not be considered successful.

Outgoing Web Service Configuration in Oriens

This is configured from the screen Users and Parameters > Additional Configuration.

Configuration Fields	Example Value	Purpose
URL WEBSERVICE DE SERVICIOS	HTTP://WS.PRUEBA.ORIENS.COM.MX (Example)	Defines the endpoint to which Oriens will send the JSON via REST POST.
USUARIO WEBSERVICE	USUARIOWS (Example)	Username if authenticating with user/password.
PASSWORD PARA WEBSERVICE	PASSWORD (Example)	Password associated with the Webservice User.
SE ENVIA AUTHORIZATION Y KEY EN HEADER PARA WEBSERVICE	TOKEN (Example)	Used if the Web Service requires token-based authentication in the HTTP header.

Oriens will send either the token or the credentials depending on what has been configured.