Documentación de los Servicios Web internos de
Zoom International Services C.A.

RIF J-00102174-4


Zoom ofrece servicios web en formato json con el motivo de extender la funcionalidad a sus clientes, proveemos un API de conexión de ejemplo realizado en PHP y Javascript (jquery) para así conectarse a los procesos que faciliten la integración entre distintas empresas. A continuación se describen los principales servicios de nuestro API, así como algunos ejemplos.

Requisitos


Servicios

zoomTrack
Definición: Retorna la información de un Envio y su tracking
Parámetros de Entrada:
Atributos de salida:
  • guia : Número con el que identificamos un envío. NOT NULL
  • tipodeenvio:tipo de envío, puede ser Documento o Mercancia NOT NULL
  • referencia: Código adicional que podría identificar a un envío. NULL
  • mensajeweb: Descripcion del estatus actual del envioNOT NULL
  • origen: Origen del envío. NOT NULL
  • destino: Destino del envío. NOT NULL
  • codigo_estatus: Estatus actual del envío. NOT NULL
  • descripcion_estatus: Descripción del estatus en el envío. NOT NULL
  • icono: Icono que identifica el estatus NOT NULL
  • ( Nuevo )
  • color: Color que define el estatus NOT NULL
  • ( Nuevo )
    Por cada tracking que tiene la guia muestra:
  • guia: Número con el que identificamos un envío. NOT NULL
  • tipodeenvio:tipo de envío, puede ser Documento o Mercancia NOT NULL
  • referencia: Código adicional que podría identificar a un envío. NULL
  • mensajeweb: Descripcion del estatus actual del envioNOT NULL
  • fecha: Fecha del Tracking. NOT NULL
  • origen: Origen del envío. NOT NULL
  • destino: Destino del envío. NOT NULL
  • fechapro: Fecha de la gestión del estatus. NOT NULL
  • codigo_estatus: Estatus de la guía en el tracking. NOT NULL
  • descripcion_estatus: Descripción del estatus que tuvo el envío. NOT NULL
  • observaciones:obvervaciones del envío. NOT NULL
  • oficina:Oficina deñ envío. NOT NULL
  • receptor: Receptor del envío. Retornará valor sólo para los siguientes estatus:
  • sello: Muestra si al entregar el envio fue sellado
  • hora: Hora de entrega del envío. Retornará valor sólo para los siguientes estatus:
  • codmensajero: Mensajero que realizo la entrega
  • posrack: posicion del rack
  • Ejemplo de respuesta: [{"guia":"372623128","tipodeenvio":"MERCANCIA","referencia":"0","mensajeweb":"","fecha":"23-03-2012","origen":"MIAMI","destino":"CARACAS","codigo_estatus":"7","descripcion_estatus":"ENTREGADO";icono":"1";color":"red"},

    {"guia":"372623128","tipodeenvio":"MERCANCIA","referencia":"0","mensajeweb":"","fecha":"23-03-2012","origen":"MIAMI","destino":"CARACAS","fechapro":"23-03-2012","codigo_estatus":"7","descripcion_estatus":"ENTREGADO","observaciones":"","oficina":"ZOOM LA URBINA","receptor":"ROSABIN","sello":"SIN SELLO","hora":"05:41p.m.","codmensajero":"NULL","posrack":""},

    {"guia":"372623128","tipodeenvio":"MERCANCIA","referencia":"0","mensajeweb":"","fecha":"23-03-2012","origen":"MIAMI","destino":"CARACAS","fechapro":"23-03-2012","codigo_estatus":"12","descripcion_estatus":"ENTREGANDOSE AL DESTINATARIO","observaciones":"","oficina":"ZOOM LA URBINA","receptor":"","sello":"","hora":"","codmensajero":"","posrack":""},

    {"guia":"372623128","tipodeenvio":"MERCANCIA","referencia":"0","mensajeweb":"","fecha":"23-03-2012","origen":"MIAMI","destino":"CARACAS","fechapro":"23-03-2012","codigo_estatus":"1","descripcion_estatus":"EN TRANSITO HACIA EL DESTINO","observaciones":"","oficina":"ZOOM MIAMI","receptor":"","sello":"","hora":"","codmensajero":"","posrack":""}]
    getlanguages
    Definición: Retorna las los lenguajes permitidos para la aplicación movil
    Parámetros de Entrada:
    Atributos de salida:
    Ejemplo de respuesta:{"id_language":"1","language_tag":"ES","language_name":"Espanol"},{"id_language":"2","language_tag":"EN","language_name":"English"}
    getRespuestastags
    Definición: Retorna información de los Tags disponibles
    Parámetros de Entrada:
    Atributos de salida:
    Ejemplo de respuesta: {"id":"3","codrespuesta":"COD_002","mensaje":"ACTUALIZACION REALIZADA EXITOSAMENTE","id_language":"1"}
    getSecciones
    Definición: retorna las secciones y sus contenidos de la información empresarial de Grupo ZOOM, según un el lenguaje seleccionado.
    Parámetros de Entrada:
    Atributos de salida:
    Ejemplo de respuesta: {"seccion":"*CONTACTOS","contenido":"*<font class="normal"><font class="titulo_negro">CALL-CENTER DE DOCUMENTOS Y CARGA</font><br><font class="normal_azul"><b>0-800-SOS-ZOOM</b> (0-800-7679666)</font><br><br><font class="titulo_negro">CALL-CENTER DE WESTERN UNION</font><br><font class="normal_azul"><b>0-800-CANGURO</b> (0-800-2264876)</font><br><br><font class="titulo_negro">CENTRAL</font> (0-212) 204-6700<br><font class="titulo_negro">FAX</font> (0-212) 242-3382<br><br><font class="titulo_negro">DIRECCIÓN</font><br>Calle 7, Sector Sur.<br>Edif. GRUPO ZOOM, La Urbina.<br>Caracas, Venezuela<br><br>*"}, {"seccion":"*CORREO ELECTRÓNICO*","contenido":"*<table border="0" cellspacing="0" cellpadding="0" width="100%"><tbody><tr><td><font class="normal">Aliados Comerciales</font></td><td><a href="mailto:aliadoscomerciales@grupozoom.com" class="medium_azul">aliadoscomerciales@grupozoom.com</a></td></tr><tr><td><font class="normal">Administración</font></td> <td><a href="mailto:administracion@grupozoom.com" class="medium_azul">administracion@grupozoom.com</a></td></tr><tr><td><font class="normal">Atención al Cliente</font></td><td><a href="mailto:calidad@grupozoom.com" class="medium_azul">calidad@grupozoom.com</a></td> </tr><tr><td><font class="normal">Compras</font></td><td><a href="mailto:compras@grupozoom.com" class="medium_azul">compras@grupozoom.com</a></td></tr></tbody></table>*"}*

    registerUsuarioCasIntWs
    Definición: Permite registrar un nuevo usuario externo, y retorna como respuesta los datos ingresados.
    Método: POST.

    Parámetros de entrada:

    - Todos los parámetros mencionados anteriormente son obligatorios, excepto 'lang'.
    - Dicho Web Service valida que no existan registros con el mismo número de cédula, teléfono celular o correo electrónico.

    Si el registro ha sido exitoso, se mostrará la siguiente información (en formato JSON):

    		{
    		  "codrespuesta": "COD_001",
    		  "mensaje": "INGRESO REALIZADO EXITOSAMENTE",
    		  "entidadRespuesta": {
    		    "tipodocumento": "1",
    		    "rifci": "19999999",
    		    "nombre": "VICTOR",
    		    "apellido": "POETA",
    		    "telefonocel": "04120000001",
    		    "email": "vpoeta@grupozoom.com",
    		    "token_contra": "15858q10499R146565369384320412583b14685",
    		    "token_incri": "790AAFE2",
    		    "inactivo": 1,
    		    "fecha": "2016-10-18",
    		    "hora": "13:30:06",
    		    "login": "vpoeta@grupozoom.com",
    		    "usuariocasint_id": 10
    		  }
    		}

    activateUsuarioCasIntWs
    Definición: Permite activar el registro del usuario, el cual retorna como respuesta los datos ingresados.
    Método: POST.

    Parámetros de entrada:

    - Todos los parámetros mencionados anteriormente son obligatorios, excepto 'lang'.

    Si la activación ha sido exitosa, se mostrará la siguiente información (en formato JSON):

    		{
    		  "codrespuesta": "COD_002",
    		  "mensaje": "ACTUALIZACION REALIZADA EXITOSAMENTE",
    		  "entidadRespuesta": {
    		    "usuariocasint_id": 10,
    		    "rifci": 19999999,
    		    "email": "vpoeta@grupozoom.com",
    		    "inactivo": 0,
    		    "telefonocel": "04120000001",
    		    "tipodocumento": 1,
    		    "fecha": "2016-10-18",
    		    "hora": "13:54:50",
    		    "nombre": "VICTOR",
    		    "apellido": "POETA",
    		    "codusuario": 0,
    		    "codcasillero": null,
    		    "codoficina": 0,
    		    "direccionip": null,
    		    "codpais": 0,
    		    "login": "vpoeta@grupozoom.com"
    		  }
    		}

    login
    Definición: Permite el ingreso del usuario externo, con las credenciales válidas (login y clave), el cual retorna como respuesta los datos del usuario autenticado y el token generado.
    Método: POST.

    Parámetros de entrada:

    - Todos los parámetros mencionados anteriormente son obligatorios, excepto 'lang'.

    Si la autenticación es exitosa, se mostrará la siguiente información (en formato JSON):

    		{
    		  "codrespuesta": "COD_000",
    		  "mensaje": "CONSULTA REALIZADA EXITOSAMENTE",
    		  "entidadRespuesta": {
    		    "usuariocasint_id": 10,
    		    "rifci": 19999999,
    		    "email": "vpoeta@grupozoom.com",
    		    "inactivo": false,
    		    "telefonocel": "04120000001",
    		    "tipodocumento": 1,
    		    "fecha": "2016-10-18",
    		    "hora": "13:58:18",
    		    "nombre": "VICTOR",
    		    "apellido": "POETA",
    		    "codusuario": 0,
    		    "codcasillero": null,
    		    "codoficina": 0,
    		    "direccionip": null,
    		    "codpais": 0,
    		    "login": "victorpoeta@gmail.com",
    		    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEwMCwiaXNzIjoiaHR0cDpcL1wvMTAuMC4xMC4
    		    xM1wvYmFhc3pvb21cL3B1YmxpY1wvY2FuZ3Vyb2F6dWxcL3JlZ2lzdHJvXC9sb2dpbiIsImlhdCI6MTQ3NjgwMzU4NiwiZ
    		    XhwIjoxNDc2ODA1Mzg2LCJuYmYiOjE0NzY4MDM1ODYsImp0aSI6ImViMmU2N2NhMzk1YjMzMjczN2VjMmU4MGYxYmFhYTQ
    		    3In0.ZJflpszxpp1bpJ-PBdZB0yDduq0SyTHlmMdMkQcfoX4"
    		  }
    		}

    getInfoUsuarioCasIntWs
    Definición: Permite consultar los datos del usuario externo, así como sus relaciones (oficina a la cual pertenece, o si tiene registro en guía electrónica).
    Método: POST.

    Parámetros de entrada:

    - Todos los parámetros mencionados anteriormente son opcionales (Si no se envían parámetros, se muestran todos los registros de usuarios).

    Si existen registros en la consulta, se mostrará la siguiente información (en formato JSON):

    		{
    		  "codrespuesta": "COD_000",
    		  "mensaje": "CONSULTA REALIZADA EXITOSAMENTE",
    		  "entidadRespuesta": [
    		    {
    		      "usuariocasint_id": 10,
    		      "login": "vpoeta@grupozoom.com",
    		      "rifci": 16952402,
    		      "email": "vpoeta@grupozoom.com",
    		      "inactivo": false,
    		      "telefonocel": "04120000001",
    		      "fecha": "2016-10-06",
    		      "hora": "06:45:46.40435",
    		      "nombre": "VICTOR",
    		      "apellido": "POETA",
    		      "codusuario": 100000788,
    		      "codcasillero": 360137,
    		      "codoficina": 46,
    		      "listoficina": {
    		        "codoficina": 46,
    		        "nombre": "ZOOM LA URBINA",
    		        "siglas": "CCS"
    		      },
    		      "listcliente": {
    		        "codcliente": 100000788,
    		        "fecha": "2016-10-06",
    		        "codoficina": 46,
    		        "nombre": "VICTOR GABRIEL POETA",
    		        "rifci": "V-16952402",
    		        "codactividadeco": 1392,
    		        "personaobl": "VICTOR GABRIEL POETA",
    		        "cargoobl": "PERSONA NATURAL",
    		        "direccionobl": " LA CANDELARIA ",
    		        "codruta": 90,
    		        "mail": "vpoeta@grupozoom.com",
    		        "codtipocli": 7,
    		        "zonaven": 117,
    		        "codpais": 124,
    		        "codciudadobl": 19,
    		        "codestadoobl": 2,
    		        "zipcode": 1010,
    		        "listclientetelefono": [
    		          {
    		            "codclientetelefono": 670,
    		            "codcliente": 100000788,
    		            "telefono": "4160000001"
    		          },
    		          {
    		            "codclientetelefono": 671,
    		            "codcliente": 100000788,
    		            "telefono": "2125555555"
    		          }
    		        ],
    		        "listcasillero": [
    		          {
    		            "codcasillero": 360137,
    		            "codoficina": 46,
    		            "codcliente": 100000788,
    		            "fecha": "2016-10-06",
    		            "inactivo": false
    		          }
    		        ],
    		        "listcontacto": [
    		          {
    		            "codcontacto": 64957,
    		            "codcliente": 100000788,
    		            "codtipocon": 1
    		          },
    		          {
    		            "codcontacto": 64958,
    		            "codcliente": 100000788,
    		            "codtipocon": 2
    		          },
    		          {
    		            "codcontacto": 64959,
    		            "codcliente": 100000788,
    		            "codtipocon": 3
    		          }
    		        ],
    		        "listserviciocliente": [
    		          {
    		            "codcliente": 100000788,
    		            "codservicio": 90,
    		            "listservicio": {
    		              "codservicio": 90,
    		              "nombre": "CASILLERO INTERNACIONAL DE CONTADO",
    		              "siglas": "BCI"
    		            }
    		          }
    		        ],
    		        "listrecolectadir": [
    		          {
    		            "codcliente": 100000788,
    		            "codrecolectadir": 2343301,
    		            "direccion": "LA CANDELARIA",
    		            "contacto": "VICTOR POETA",
    		            "codcasillero": 360137,
    		            "codusuario": 999
    		          }
    		        ]
    		      }
    		    }
    		  ]
    		}

    getTokenContraUsuarioCasIntWs
    Definición: Permite obtener el token del usuario activo.
    Método: POST.

    Parámetros de entrada:

    - Todos los parámetros mencionados anteriormente son obligatorios, excepto 'lang'.

    Si existen registros en la consulta, se mostrará la siguiente información (en formato JSON):

    		{
    		  "codrespuesta": "COD_000",
    		  "mensaje": "CONSULTA REALIZADA EXITOSAMENTE",
    		  "entidadRespuesta": [
    		    {
    		      "usuariocasint_id": 100,
    		      "login": "victorpoeta@gmail.com",
    		      "tipodocumento": 1,
    		      "rifci": 16952403,
    		      "email": "victorpoeta@gmail.com",
    		      "inactivo": false,
    		      "telefonocel": "04160000001",
    		      "nombre": "VICTOR",
    		      "apellido": "POETA",
    		      "codoficina": 0,
    		      "token_contra": "u6662D1421W2125D14173X14567M11693D9897",
    		      "listoficina": null
    		    }
    		  ]
    		}

    resetPasswordUsuarioCasIntWs
    Definición: Permite el cambio de la clave del usuario.
    Método: POST.

    Parámetros de entrada:

    - Todos los parámetros mencionados anteriormente son obligatorios, excepto 'lang'.

    Si existen registros en la consulta, se mostrará la siguiente información (en formato JSON):

    		{
    		  "codrespuesta": "COD_002",
    		  "mensaje": "RECORD UPDATED SUCCESFULLY"
    		}	

    Ejemplo

     

     

    Ir al cielo