Sobre la API
En esta sección podrás entender cómo implementar la API de Shipit, para automatizar y mejorar la logística de tu eCommerce.
Todo consiste en simplificar la operación del día a día aprovechando la tecnología desarrollada por Shipit, para usar multi-couriers, hacer seguimiento de tus envíos y gestionar tu bodega con sólo unos clicks.
La documentación se divide en las siguientes categorías:
- Envíos: Crear pedidos y consultar información sobre el estado de estos.
- Cotizador: Consultar precios de envío según sus dimensiones y destino.
- Inventario: Consultar sobre el stock actual de tu tienda. Sólo para clientes que cuenten con el servicio de Fullfilment de Shipit.
- Cobertura: Localidades a las cuales Shipit puede despachar.
- Webhooks: Información para la implementación de webhooks a través de la API de Shipit.
Autenticación
Cómo consumir la API de Shipit
Para consumir nuestra API es necesario tener:
- Una cuenta Shipit
- El correo asociado a la cuenta (X-Shipit-Email)
- El Token de Acceso obtenido en el módulo de la API en tu cuenta (X-Shipit-Access-Token)
Esta información deberá ser enviada a través del los headers HTTP, para hacer request a los Endpoints de la API.
Content-Type: application/json
X-Shipit-Email: [email protected]
X-Shipit-Access-Token: XXXXXXXXXXX
Accept: application/vnd.shipit.v2Respuestas de la API
Posibles respuestas de la API de Shipit.
200
OK
¡Todo funciona con éxito!
201
Creando
Cuando esté creando un nuevo objeto, éste se devolverá con éxito.
400
Solicitud incorrecta
No se pudo realizar la operación.
403
Prohibido
No pudimos autenticarte, o no tienes acceso a este objeto.
Consultar precio (v3 Estable)
Obtiene todos los precios de referencia de los Couriers. Hemos estado mejorando el API y ésta será la versión a la que estaremos dando soporte.
Consultar SKU por Nombre
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
$.get('http://yoursite.com/test/' + id, function(data) {
console.log(data);
});Webhook
Para poder implementar nuestros webhook necesitas indicar una URL en donde recibirás la información. Esto lo podrás encontrar iniciando sesión en tu cuenta y luego ingresando al módulo de la API debes ir abajo a la sección Webhooks.
Nuestros webhooks te entregará dos resultados:
Envios:
POST: Cuando creas un pedido, el webhook responderá con POST y la información del package creado.
PUT: Cuando se actualiza la información del package. Por ejemplo: se asigna un número de seguimiento a tu envío o se actualizó el estado de pedido.
SKU
POST: Cuando el cliente ingresa un nuevo SKU en nuestra plataforma, el webhook responderá con POST y la información del SKU creado.
PUT: Cuando se actualiza la información del SKU. Por ejemplo: cuando se ingresa y descuenta stock
IMPORTANTE: A contar del día 15 de Mayo de 2019, el formato de respuestas de nuestros webhooks cambiara de URL-ENCODE a JSON es relevante comunicarte con tu desarrollador para actualizar la manera de obtener las respuestas de nuestros webhook, ya que, a contar de la fecha indicada sera deprecada la version URL-ENCONDE.
Tips para desarrolladores: ingresa a https://webhook.site para obtener la información del webhook configurado en shipit
Un ejemplo del nuevo formato sera entregado a continuación:
{
"id": 16,
"reference": "1",
"full_name": "mich tst ",
"email": "",
"items_count": 1,
"cellphone": "",
"is_payable": false,
"packing": "Sin Empaque",
"shipping_type": "Normal",
"destiny": "Domicilio",
"courier_for_client": null,
"tracking_number": null,
"approx_size": "Pequeño (10x10x10cm)",
"status": "in_preparation",
"courier_status": null,
"length": 10,
"width": 10,
"height": 10,
"weight": 1,
"delivery_time": null,
"created_at": "2019-04-27T16:30:00.000-04:00",
"updated_at": "2019-04-25T18:38:23.422-04:00",
"courier_url": "Sin tracking",
"old_ticket_url_courier": null,
"ticket_shipit_url": null,
"ticket_url": null,
"ticket_shipit_pdf_url": null,
"link": "http://example.org/v/packages/16",
"address": {
"street": "alonso de cordoba",
"number": "4499",
"complement": "alonso de cordoba 4499",
"commune": "PUDAHUEL",
"coords": {
"latitude": 0,
"longitude": 0
}
},
"inventory_activity": {
"inventory_activity_orders_attributes": [
{
"sku_id": 2,
"amount": 1,
"warehouse_id": 3
},
{
"sku_id": 3,
"amount": 2,
"warehouse_id": 3
}
]
},
"integration_reference": "1"
}
{
"id": 1,
"name": "Prueba de sku",
"company_id": 1,
"position": null,
"description": "Prueba de sku",
"created_at": "Wed, 06 Nov 2019 10:52:24 CLST -03:00",
"updated_at": "Wed, 06 Nov 2019 10:52:24 CLST -03:00",
"warehouse_id": 4,
"width": 15.0,
"length": 3.0,
"height": 23.0,
"weight": 0.3,
"barcode": "9789563606379",
"amount": 0,
"min_amount": 0,
"ftp_stock": 0,
"ftp_updated_at": 0,
"stock": {
"id": 1,
"received": 0,
"commited": 0,
"waste": 0,
"canceled": 0,
"available": 10,
"created_at": "Wed, 06 Nov 2019 10:52:24 CLST -03:00",
"updated_at": "Wed, 06 Nov 2019 10:52:24 CLST -03:00",
"ftp_stock": 0,
"ftp_updated_at": null,
"sku_id": 1,
"min_available": 3
}
}Actualización
Actualiza la configuración de tu webhook
Configuración del webhook
Ahora es posible agregar encriptación y autenticación a los webhooks
Encriptación:
Para poder encriptar el contenido del webhook (body) es necesario activar esta opción y ademas agregar el token de encriptacion / desencriptacion:"sign_body": { "required": true, "token": "token" }.
Con estos datos nuestro sistema realiza la encriptación del webhook con la codificación SHA1 para mas información https://developer.github.com/webhooks/securing/
Autenticación:
Para evitar abrir una url dentro de tu sitio agregamos la opción de autenticar los webhooks, para poder activar esta opción debes actualizar la opción authorization.required a true ademas agregar el tipo de autenticación que necesitas, opciones disponibles: (Basic, Bearer, Token=).
esta autenticación esta basada en HEADERS con el key ej:Authorization: Bearer token.....Authorization: Basic token.....
El objeto a configurar es el siguiente:"authorization": {
"required": true,
"kind": "Bearer",
"token": "TOKEN"
}
Flujo API Shipit
Caso de uso de implementación de nuestra API
A continuación te damos un ejemplo de como utilizar nuestra API para la implementación de una tienda ECommerce
