API Docs v2

En Zippin ponemos a disposición de nuestros clientes esta segunda versión de nuestra interfaz de programación. Es una API REST, lo que significa que la interacción es mediante llamadas HTTP típicas (GET, POST, PUT), intercambiando datos en formato JSON.

La URL base para los requests es https://api.zippin.com.ar/v2

Para armar cada URL se indica el path del endpoint. Cada recurso está disponible con un método (GET; POST etc) determinado.

Headers a enviar en cada request

Además del header de autenticación es importante indicar el tipo de contenido aceptado para las respuestas en todos los requests:

Accept: application/json

Adicionalmente, en requests de tipo POST y PUT se debe incluir un header que indique el Content-Type del payload (application/json).

Content-Type: application/json

Ejemplo de un request GET

curl https://api.zippin.com.ar/v2/shipments?page=2 \
  -H "Accept: application/json"
  -v -u zippin:12345678 -X GET

Ejemplo de un request PUT

curl https://api.zippin.com.ar/v2/shipments/233322 \
  -d '{"status": "Entregado", "reason":"Ok"}' \
  -H "Content-Type: application/json" -H "Accept: application/json"
  -v -u zippin:12345678 -X PUT

Para simplificar los ejemplos, en esta guía no se incluirá todo el formato de un request curl sino una versión simplificada de la URL, método, payload y respuesta esperada.

Los textos entre llaves  Ej. {id} indican dónde se debe poner un valor dentro de una URL y de qué atributo se trata.