La API de WeShipYou está organizada según REST. Tiene URL predecibles y orientadas a recursos, acepta cuerpos de solicitud JSON, devuelve respuestas JSON y usa los códigos de estado y verbos HTTP estándar.
Pruebas y producción
Prueba primero tu integración contra el servidor Sandbox (sandbox.weshipyou.com): nada de lo que hagas allí llega a un transportista real ni mueve dinero real. El servidor de Producción (weshipyou.com) es real: las etiquetas que compres allí se cobran de tu billetera.
La API trabaja con un objeto por solicitud; no hay actualizaciones masivas.
OpenAPI
Esta referencia se genera a partir de un documento OpenAPI 3.1. Descárgalo desde /docs/api/openapi.json e impórtalo en Postman o en cualquier herramienta compatible con OpenAPI.
Solicitudes de origen cruzado
La API admite CORS para cualquier origen, así que puedes llamarla desde un navegador. Nunca pongas un token de acceso en código que otras personas puedan leer.
Autenticación
La API autentica cada solicitud con un JSON Web Token (JWT). No hay claves de API.
- Llama a
POST /authenticationcon tu usuario (o correo) de WeShipYou y tu contraseña. Si tu usuario tiene activada la autenticación de dos factores, envía también el código actual de 6 dígitos de tu app de autenticación comotwoFactorToken. - Envía el
accessTokenque recibes en todas las demás solicitudes, en el encabezadoAuthorization: Bearer <accessToken>. - El token vence en
exp(una marca de tiempo Unix en la respuesta). Inicia sesión de nuevo para obtener otro.
Una solicitud sin un token válido responde 401 NotAuthenticated. Una solicitud para una cuenta de la que no eres miembro responde 403 Forbidden o 404 NotFound.
- JWT
- HTTP bearer · JWT
El token de acceso de
POST /authentication(válido hasta suexp), enviado comoAuthorization: Bearer <accessToken>.Envíalo como Authorization: Bearer <token>