Inicio rápido
Obtén un token, crea un envío, compra su etiqueta y rastréalo, todo contra el sandbox.
Esta guía recorre las cinco llamadas de una primera integración. Todos los ejemplos usan el servidor sandbox, https://sandbox.weshipyou.com/api/v1, así que nada de lo que hagas aquí se cobra de tu billetera real. Lee Modo de prueba y modo real antes de pasar a real.
Antes de empezar
- Tu usuario de WeShipYou. Obtienes un token del sandbox con tu inicio de sesión real: el sandbox guarda una copia de prueba de tu usuario y tus cuentas, sin saldo.
- Una terminal con
curl, o Node.js 18 o posterior (traefetchincluido).
1. Obtén un token de acceso
Inicia sesión en real con "mode": "test". Real comprueba tu usuario y contraseña y responde con un token del sandbox. Si la autenticación de dos factores está activada para tu usuario, envía también el código actual de 6 dígitos en twoFactorToken.
curl -X POST https://weshipyou.com/api/v1/authentication \
-H "Content-Type: application/json" \
-d '{"username": "janedoe", "password": "your-password", "mode": "test"}'Guarda el accessToken en una variable de entorno. Los ejemplos siguientes lo leen de WSY_ACCESS_TOKEN:
export WSY_ACCESS_TOKEN="eyJhbGciOi..."2. Busca tu cuenta
Los envíos pertenecen a una cuenta. Lista las cuentas de las que eres miembro y anota el accountNumber (empieza por CU) de la que usas para enviar. Tus subcuentas también aparecen en la lista, cada una con su cuenta principal en parentUid (consulta Subcuentas).
curl https://sandbox.weshipyou.com/api/v1/accounts \
-H "Authorization: Bearer $WSY_ACCESS_TOKEN"3. Crea un envío
Envía el remitente, el destinatario y los paquetes. La respuesta es el envío, con su uid y los servicios con los que se puede enviar en parcel_rates.
curl -X POST https://sandbox.weshipyou.com/api/v1/shipments \
-H "Authorization: Bearer $WSY_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d @shipment.jsonLa referencia de Crear un envío tiene un shipment.json completo para empezar.
4. Compra la etiqueta
Elige una de las parcel_rates y cómprala. El precio se toma primero del saldo de tu billetera; solo lo que el saldo no cubre se cobra a paymentMethod.
curl -X POST https://sandbox.weshipyou.com/api/v1/shipments/labels \
-H "Authorization: Bearer $WSY_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"accountId": "CU1234567",
"handoverOptions": [{
"handoverOption": "dropoff",
"shipments": [{ "shipmentId": "<shipment uid>", "rateId": "<parcel_rates[].uid>" }]
}]
}'5. Rastréalo
Lee el envío para obtener su número de rastreo (label.trackingNumber) y luego pide su estado y sus puntos de control.
curl https://sandbox.weshipyou.com/api/v1/tracking/WSY0000000000US \
-H "Authorization: Bearer $WSY_ACCESS_TOKEN"Próximos pasos
- Autenticación: duración del token, códigos de dos factores y cómo proteger los tokens.
- Etiquetas: tarifas, pago, opciones de entrega y cancelación.
- Subcuentas: créalas, lístalas y envía en nombre de una de ellas.
- Errores: qué significa cada estado y cuándo reintentar.