En ZOOM ofrecemos una plataforma que permite compartir recursos tecnológicos de manera pública y privada, para que nuestros clientes y aliados puedan conectarse a nuestros servicios
Para ello, facilitamos API’s totalmente gratuitas y fáciles de integrar, que se encuentran en formato JSON y que pueden ser llamadas a través del protocolo HTTPS utilizando los métodos GET y POST.
- Formas de uso
APIs públicos, son aquellos que no requieren una credencial para ser consumidos. Son utilizados para consultar la información, como por ejemplo rastreo de los envíos, cálculos de precios, oficinas disponibles para recibir envíos, entre otros.
APIs privados, dirigidos a nuestros clientes corporativos y aliados, en los cuales ZOOM solicita autenticación y una frase privada, que es única por cada cliente o aliado. Son utilizados para la creación de transacciones, como por ejemplo: creación e impresión de guías, creación de casos para atención al cliente, entre otros.
- Ambiente de Pruebas
Te ofrecemos un servidor de pruebas disponible las 24 horas con el objetivo de realizar los procesos requeridos para la integración. Una vez realizadas las mismas y previa verificación por parte de nuestra área de Sistemas y Tecnología, podrá obtener las credenciales para el uso de las APIs en ambiente de producción.
- Credenciales para conectarse al Ambiente de Pruebas:
Las credenciales para autenticar son provistas una vez el cliente inicia el trámite de enrolamiento con el equipo de Ventas de ZOOM.
- Tipos de Respuestas
Todas las solicitudes y respuestas se formatean utilizando el formato de intercambio JSON (Objeto o Array) https://www.json.org/ ya que es un formato ligero de intercambio de datos, que resulta sencillo de leer y escribir para los programadores y simple de interpretar y generar para las máquinas. Se eligió este formato porque nos permite agregar nuevos campos a nuestras respuestas y hacer evolucionar nuestra API con el tiempo sin romper los analizadores conformes.
| Codrespuesta | Mensaje |
| CODE_000 | INFORMACIÓN NO EXISTE EN BASE DE DATOS |
| CODE_000 | INFORMATION DOES NOT EXIST IN DATABASE |
| CODE_001 | ERROR AL REALIZAR LA CONSULTA |
| CODE_001 | ERROR IN EXECUTING QUERY |
| CODE_002 | LOS PARÁMETROS INGRESADOS NO SON CORRECTOS |
| CODE_002 | THE PARAMETERS ENTERED ARE INCORRECT |
| CODE_003 | ERROR EN LA LLAMADA AL SERVICIO |
| CODE_003 | ERROR IN SERVICE CALL |
| CODE_004 | ERROR ESTE REGISTRO YA SE ENCUENTRA EN LA BASE DE DATOS |
| CODE_004 | ERROR. THIS RECORD EXISTS IN DATABASE |
| CODE_005 | ERROR. ESTE REGISTRO NO PUDO SER ACTUALIZADO |
| CODE_005 | ERROR. THIS RECORD COULD NOT BE UPDATED |
| CODE_006 | ERROR AL CONECTAR CON SAP |
| CODE_006 | FAILED TO CONNECT TO SAP APPLICATION |
| CODE_007 | EL REGISTRO NO PUDO SER INSERTADO |
| CODE_007 | THIS RECORD COULD NOT BE INSERTED |
- Documentación
Para mayor información sobre las APIs disponibles y conocer su funcionamiento, le invitamos a visitar nuestra amplia documentación consultando AQUÍ
La url para el consumo las APIs públicas en el servidor de pruebas es la siguiente:
http://sandbox.zoom.red/baaszoom/public/canguroazul
Si desea utilizar el servicio getEstados (por ejemplo), la ruta sería la siguiente:
http://sandbox.zoom.red/baaszoom/public/canguroazul/getCiudades
- Pase a producción
Después de hacer las pruebas en nuestro ambiente de pruebas, debes notificar al equipo de Ventas de ZOOM la culminación de la integración.
Les solicitaremos que nos envíen información básica de la empresa, persona contacto, teléfono fijo y celular, página web.
Antes de suministrarles los datos para acceder a producción, el equipo de Sistemas de ZOOM debe certificar las pruebas realizadas. El cliente deberá enviar, por ejemplo, números de guías generadas, PDFs de la guía impresa, impresión de una consulta de rastreo de un envío, entre otros.
Una vez culminada la certificación, ZOOM suministrará las credenciales de acceso de producción para realizar nuevas pruebas controladas, para así certificar que todo funcione.
Durante los procesos de certificación del cliente, es importante que se realicen pruebas usando valores extremos de pesos y valor declarado, ciudades que no existen, entre otros, para verificar los mensajes de validaciones de errores que retornan los API.
Cargando...
