Comenzar con Ziipco API

Ziipco API es una API RESTful que permite a los desarrolladores integrar servicios de mensajería en sus aplicaciones. Esta documentación proporciona una guía paso a paso para comenzar a usar Ziipco API.

Obtener credenciales de API

Dirígete a Credenciales API para obtener tus llaves. Si no cuentas con una cuenta, puedes registrarte o iniciar sesión.

Si no ves ninguna llave en la página, ponte en contacto con el soporte de Ziipco.

Credenciales y como generar una petición correctamente

Cada credencial de API consta de 4 elementos:

• Ambiente: determina si la llave es para producción o sandbox (pruebas).
• Id de usuario o clientId: identificador único de tu cuenta.
• Username: usuario que autentica tu petición.
• Password: contraseña que autentica tu petición.

Para realizar una petición a la API, debes incluir las credenciales en la cabecera de la petición HTTP como autorización básica. La autorización básica es un método de autenticación HTTP que consiste en codificar en base64 el username y password separados por dos puntos (:).

POST /api/users/{clientId}/quoter HTTP/1.1
Host: sistema.ziipco.com
Content-Type: application/json
Authorization: Basic base64_encode(username:password)

{
    "origin": {
        "country": "MX",
        "zipCode": "62000"
    },
    "destination": {
        "country": "MX",
        "zipCode": "62000"
    },
    "height": 5,
    "length": 5,
    "width": 5,
    "weight": 5,
    "insurance": false
}

• Donde {clientId} es el identificador único de tu cuenta.
• base64_encode(username:password) es el username y password codificados en base64.
• /quoter es el endpoint al que deseas acceder.

Intenta mandando una petición a la API con tus credenciales, si todo sale bien, recibirás una respuesta con el código 200, que significa que el cuerpo de la petición es válido y la petición fue exitosa.

Si recibes una respuesta con el código 401, significa que tus credenciales son incorrectas.

Codificar en base64

Verifica que las credenciales sean correctas y que estén bien codificadas en base64. De otro modo, ponte en contacto con el soporte de Ziipco. Para codificar en base64 puedes utilizar una herramienta en línea como base64encode.org.

Ambientes

Ziipco API cuenta con dos ambientes: producción y sandbox.

La forma en que se accede a cada ambiente es a través de cada credencial de API. Cada credencial tiene un ambiente asociado que determina si la petición se realizará en producción o en sandbox.

Producción

El ambiente de producción es el ambiente en el que se realizan las peticiones reales a la API. Para acceder a este ambiente, debes utilizar las credenciales de producción.

En este ambiente, las peticiones son reales y se cobran de acuerdo a la tarifa establecida por Ziipco.

Sandbox

El ambiente de sandbox es un ambiente de pruebas en el que se pueden realizar peticiones sin costo alguno. Para acceder a este ambiente, debes utilizar las credenciales de sandbox.

En este ambiente, las peticiones no son reales y no se cobran. Es un ambiente seguro para probar la API sin preocuparte por los costos.

Conclusión

¡Felicidades! Ahora sabes cómo obtener tus credenciales de API y cómo realizar una petición a la API de Ziipco. Si tienes alguna duda, no dudes en ponerte en contacto con el soporte de Ziipco. ¡Buena suerte!