Skip to main content
InicioBlogGuíasDocumentación de la API de seguimiento de UPS: 7 características clave que los desarrolladores deben conocer

Documentación de la API de seguimiento de UPS: 7 características clave que los desarrolladores deben conocer

17TRACK

La documentación de la API de seguimiento de UPS es más útil cuando ayuda a un desarrollador a pasar de un número de seguimiento a una experiencia confiable de consulta del estado del envío. Las siete áreas que se deben examinar son la autenticación, las solicitudes de seguimiento, los esquemas de respuesta, el historial de eventos, la gestión de errores, los límites operativos y las pruebas. UPS ofrece su propia plataforma para desarrolladores para integraciones directas con UPS, mientras que un servicio multioperador como 17TRACK Tracking API puede ser más adecuado cuando una sola integración debe admitir UPS y otros operadores.

Ups Tracking Api Documentation 7 Key Features Developers Should Know

La implementación adecuada depende del sistema que se esté construyendo. Un minorista puede necesitar actualizaciones de entrega en una página de pedido, un equipo de almacén puede necesitar alertas de incidencias y una plataforma empresarial puede requerir datos de seguimiento normalizados de varios operadores. Leer la documentación teniendo en cuenta esos casos de uso ayuda a evitar un error común: tratar una respuesta correcta de la API como si fuera lo mismo que una solución completa de visibilidad del envío.

Qué debería ayudarte a responder la documentación de la API de seguimiento de UPS

Antes de escribir código, aclara cuatro preguntas:

  • ¿Vas a integrar únicamente UPS o el sistema hará seguimiento de varios operadores?
  • ¿Necesitas el estado actual del paquete, el historial completo de escaneos o ambos?
  • ¿Tu aplicación solicitará actualizaciones bajo demanda, recibirá notificaciones o utilizará una combinación de ambos métodos?
  • ¿Qué deberían ver los clientes y los equipos internos cuando un envío se retrasa, se entrega, se devuelve o aún no se encuentra?

La documentación de UPS es la fuente principal para consultar las credenciales actuales, las operaciones admitidas, los requisitos de las solicitudes, los campos de respuesta y las condiciones de acceso comercial. Estos detalles pueden cambiar según el producto de la API, la configuración de la cuenta o la versión de la plataforma para desarrolladores, por lo que el código de producción debe seguir el portal actual para desarrolladores de UPS en lugar de depender de un ejemplo de código antiguo.

7 características clave que los desarrolladores deben comprender

1. Autenticación y acceso de la aplicación

La autenticación es la primera característica práctica porque determina cómo una aplicación demuestra su identidad y obtiene permiso para llamar a la API. La documentación para desarrolladores de UPS proporciona el proceso actual para registrar una aplicación, crear credenciales, solicitar acceso y administrar tokens. La documentación describe un acceso basado en OAuth para las API de UPS, pero los desarrolladores deben confirmar el flujo de concesión actual, los ámbitos, la duración de los tokens y los requisitos del entorno en el portal activo antes de la implementación.

Mantén las credenciales en el lado del servidor. No deben estar incorporadas en JavaScript del navegador, compilaciones móviles, repositorios públicos ni código de páginas de seguimiento visible para el cliente. Una arquitectura más segura coloca un servicio backend entre la aplicación orientada al cliente y UPS. Ese servicio puede autenticarse de forma segura, hacer cumplir los límites de solicitudes, registrar los resultados técnicos sin exponer secretos y devolver únicamente los datos del envío que necesita el frontend.

Separa también las credenciales de desarrollo de las credenciales de producción cuando la plataforma de UPS admita entornos separados. Una lista de comprobación de despliegue debe incluir el almacenamiento de secretos, la rotación, la propiedad del acceso, la gestión de tokens caducados y una alerta cuando los fallos de autenticación comiencen a aumentar.

2. Solicitudes con números de seguimiento y contexto del operador

Una integración de seguimiento necesita una forma predecible de enviar un identificador de seguimiento y solicitar información del envío. Las preguntas importantes no se limitan a la dirección del endpoint. Incluyen el formato aceptado del número de seguimiento, si la solicitud admite uno o varios números, cómo se identifica al operador y cómo responde la API cuando el número está incompleto o aún no se reconoce.

No des por hecho que toda cadena que parezca un número de seguimiento pertenece a UPS. Si tu aplicación recibe etiquetas de varios sistemas de envío, almacena el operador en un campo separado siempre que se conozca. El enrutamiento basado en el operador reduce las coincidencias falsas y facilita la resolución de problemas. También crea una vía clara para futuras ampliaciones si tu empresa incorpora otro operador.

Valida los datos de entrada antes de realizar una solicitud, pero evita una validación excesivamente estricta que rechace un identificador legítimo porque su formato cambió o porque la etiqueta se creó recientemente. La respuesta de la API sigue siendo la comprobación de autoridad. Almacena el valor original, un valor normalizado utilizado para la consulta, el operador, la referencia del pedido y la hora de la última consulta correcta.

3. Un esquema de respuesta estructurado

La documentación útil de la API de seguimiento de UPS explica cómo se organizan los datos del envío y qué campos son opcionales. Los desarrolladores deben examinar el modelo de respuesta para conocer la identidad del envío, el estado actual, la descripción del estado, las marcas de tiempo de los escaneos, las ubicaciones, las estimaciones de entrega, la información del servicio y los detalles a nivel de paquete. La ausencia de un campo no equivale necesariamente a un campo que contiene un valor vacío, y ninguno de los dos debe tratarse automáticamente como un envío fallido.

Construye un modelo interno normalizado en lugar de vincular toda la aplicación directamente a los nombres de campos específicos del proveedor. Por ejemplo, tu base de datos podría mantener un identificador del envío, el operador, el estado actual, la hora del último evento, la hora estimada de entrega, la hora de entrega, el código de incidencia y la carga útil sin procesar del proveedor. Los campos normalizados permiten generar informes y crear interfaces de usuario; la carga útil sin procesar facilita las auditorías y futuros cambios de mapeo.

Conserva las marcas de tiempo con su desfase o información de zona horaria cuando se proporcione. Mostrar un escaneo de una ubicación como si hubiera ocurrido en la hora local del usuario puede crear narrativas de entrega confusas. Del mismo modo, no conviertas el estado detallado de un operador en una etiqueta más simple hasta que la regla de negocio esté documentada.

4. Historial de escaneos e interpretación del estado

El valor del UPS tracking suele estar en la secuencia de eventos y no en una única etiqueta de estado actual. Un paquete puede pasar por la creación de la etiqueta, la recogida, el tránsito, un escaneo de llegada, una incidencia, un evento de salida para entrega y la entrega. Una integración utilizable almacena los eventos en orden y conserva sus descripciones originales siempre que sea posible.

El mapeo de estados requiere criterio editorial y operativo. “En tránsito” puede abarcar varias etapas diferentes, mientras que “incidencia” puede requerir una explicación más específica que el nombre del estado. Tu aplicación debe distinguir al menos entre movimiento normal, actividad de entrega, entregado, incidencia, devuelto y un estado que aún no se puede determinar. El mapeo exacto debe seguir los campos y códigos documentados por UPS, no suposiciones basadas únicamente en las descripciones en inglés.

En las páginas orientadas al cliente, muestra el último evento relevante, su hora y una explicación breve. Para las operaciones internas, conserva el historial completo de eventos y el texto original del operador. Esto permite que el personal de soporte investigue una reclamación sin pedir al cliente que repita información que el sistema ya recibió.

5. Estimaciones de entrega y gestión de incidencias

Los desarrolladores suelen centrarse en el flujo correcto, pero las estimaciones de entrega y las incidencias determinan si los datos de seguimiento son útiles en la práctica. Un envío puede no tener ninguna estimación, la estimación puede cambiar o una incidencia puede interrumpir temporalmente el movimiento normal. Se debe revisar la documentación para conocer los campos y las condiciones que representan estos casos.

Nunca presentes una estimación como una garantía a menos que las condiciones del servicio de UPS correspondiente respalden explícitamente esa interpretación. En la interfaz de usuario, etiqueta una estimación como tal y muestra la fecha o el intervalo horario exactamente como lo permitan los datos. Si la API omite una estimación, muestra un mensaje neutro como “Actualmente no hay ninguna estimación de entrega disponible” en lugar de inventar una a partir de una regla genérica de tiempo de tránsito.

Los flujos de trabajo para incidencias deben ser explícitos. Decide si una nueva incidencia activa un correo electrónico, una tarea del servicio de asistencia, una acción de gestión de pedidos o únicamente un cambio de estado. Añade deduplicación para que las consultas repetidas no envíen la misma alerta varias veces. Una regla práctica consiste en comparar el identificador del evento o una combinación estable de la hora del evento, el estado y la descripción antes de crear una nueva notificación.

6. Errores, reintentos y límites operativos

La documentación de la API debe leerse como un contrato operativo, no solo como una lista de ejemplos correctos. Los desarrolladores deben comprender los errores de autenticación, las solicitudes no válidas, los números de seguimiento desconocidos, los fallos temporales del servicio, los tiempos de espera agotados y las respuestas de límite de frecuencia. Cada categoría merece una respuesta diferente.

  • Los fallos de autenticación deben generar una alerta de ingeniería y no se deben reintentar indefinidamente.
  • Los errores de validación deben registrarse con suficiente contexto para corregir la solicitud.
  • Los fallos temporales pueden reintentarse con retroceso exponencial y un número máximo de intentos.
  • Los números de seguimiento desconocidos o recién creados pueden comprobarse de nuevo más adelante, pero no deben clasificarse como perdidos.
  • Las respuestas de límite de frecuencia deben ralentizar la programación de consultas y respetar los límites indicados en la documentación actual de UPS.

Utiliza tiempos de espera, interruptores de circuito, identificadores de solicitud y registros estructurados. Almacena el estado de respuesta del proveedor, el ID interno del envío y la marca de tiempo, pero excluye los tokens de acceso y la información personal innecesaria. Si la documentación especifica encabezados de respuesta o instrucciones de reintento, incorpóralos en lugar de aplicar una política genérica.

7. Pruebas, supervisión y preparación para producción

Una integración con una API de seguimiento debe probarse con más de un número de seguimiento correcto. Crea casos de prueba para una etiqueta recién generada, un envío con varios escaneos, una incidencia, un paquete entregado, un número desconocido, una credencial caducada, una solicitud con formato incorrecto, un tiempo de espera agotado y un evento duplicado. Los datos de prueba exactos y el comportamiento del entorno aislado deben confirmarse en el entorno para desarrolladores de UPS, ya que los datos de envíos reales y los entornos de prueba no siempre se comportan de forma idéntica.

Supervisa tanto los resultados técnicos como los empresariales. Las métricas técnicas incluyen el volumen de solicitudes, la latencia, la tasa de tiempos de espera agotados, los fallos de autenticación, la tasa de errores del proveedor y el número de reintentos. Las métricas empresariales incluyen el porcentaje de envíos con un evento reciente, la antigüedad del envío más antiguo sin actualizar y el número de pedidos afectados por una incidencia. Un servicio puede tener una tasa baja de errores HTTP y aun así proporcionar información de seguimiento obsoleta si las consultas o el procesamiento de eventos se han detenido.

Antes del lanzamiento, documenta cómo pausar las consultas, rotar las credenciales, volver a procesar respuestas fallidas, corregir un mapeo de estado incorrecto y contactar con el soporte de UPS. Conserva la carga útil del proveedor durante un periodo de retención controlado si es necesaria para la investigación, y revisa los requisitos de privacidad y conservación de datos con el responsable correspondiente.

¿Integración directa con UPS o una API multioperador?

Una integración directa con UPS es una opción razonable cuando UPS es el único operador incluido en el alcance, el equipo quiere gestionar el modelo específico del operador y se dispone del acceso requerido a la API de UPS. Puede ofrecer un ajuste estrecho con la terminología y los procesos operativos de UPS.

Una API multioperador puede encajar mejor desde el punto de vista arquitectónico cuando la misma aplicación debe hacer seguimiento de paquetes de UPS, operadores postales y otros proveedores logísticos. La documentación de la API de 17TRACK debe revisarse para conocer su modelo de autenticación actual, las operaciones admitidas, la estructura de las respuestas, el comportamiento de los webhooks, las condiciones de uso y la cobertura de operadores antes de tomar una decisión técnica. Su valor en este escenario no consiste en que elimine la necesidad de consultar la documentación, sino en que el equipo de desarrollo puede evaluar una capa de integración frente al coste de mantener varias conexiones específicas de cada operador.

Realiza la comparación mediante una prueba de concepto. Utiliza el mismo ciclo de vida del envío para cada opción y mide el esfuerzo de implementación, la integridad de los campos, la actualidad de los eventos, el comportamiento de los reintentos, los requisitos de webhooks o consultas, la observabilidad y el trabajo necesario cuando un operador cambia su respuesta. No selecciones un proveedor únicamente porque una solicitud de ejemplo sea breve. La opción más adecuada es la que respalda el resultado operativo que debe ofrecer tu aplicación.

Secuencia práctica de implementación

  1. Define los resultados para el usuario y las operaciones, como una página de seguimiento para clientes o una cola de incidencias.
  2. Confirma si el alcance se limita a UPS o incluye varios operadores.
  3. Lee la documentación oficial actual sobre autenticación, solicitudes de seguimiento, campos de respuesta, errores, límites y pruebas.
  4. Crea un modelo de envíos y eventos independiente del proveedor.
  5. Implementa una autenticación segura en el lado del servidor y la validación de datos de entrada.
  6. Almacena por separado las respuestas sin procesar y los campos normalizados.
  7. Añade consultas o ingestión de eventos con deduplicación y retroceso.
  8. Prueba solicitudes normales, retrasadas, excepcionales, desconocidas y fallidas.
  9. Lanza el sistema con supervisión de la actualidad de los datos, los fallos y los envíos obsoletos.

Esta secuencia evita que la llamada a la API se convierta en todo el diseño. El seguimiento es un proceso continuo de datos: la aplicación debe obtener eventos, interpretarlos cuidadosamente, presentarlos con claridad y recuperarse cuando el proveedor o la red no estén disponibles.

Preguntas frecuentes

¿Qué debería leer primero en la documentación de la API de seguimiento de UPS?

Empieza por la autenticación y la operación de seguimiento. Después revisa los requisitos de las solicitudes, los campos de respuesta, el comportamiento de los errores, los límites de uso y las instrucciones de prueba. Esas secciones revelan si la API encaja con tu modelo de seguridad y tus requisitos de datos antes de que inviertas en una integración completa.

¿Puedo utilizar una API de seguimiento de UPS para una página de seguimiento orientada al cliente?

Sí, una API puede proporcionar datos para una página orientada al cliente, pero la página debe servirse a través de tu backend en lugar de exponer las credenciales de la API en el navegador. Diseña la página para distinguir entre el estado actual, el historial de escaneos, las estimaciones y las incidencias, y evita presentar las estimaciones como garantías.

¿Se deben consultar continuamente los números de seguimiento?

No necesariamente. La frecuencia de las consultas debe reflejar la etapa del envío, la urgencia empresarial, los límites de uso documentados y si existe una opción basada en eventos. Utiliza retroceso para los envíos sin cambios y detén o reduce las consultas después de la entrega o de un estado terminal de devolución.

¿Cuál es la diferencia entre un número de seguimiento desconocido y un paquete perdido?

Un número de seguimiento desconocido significa que la solicitud actual no devolvió un resultado de envío reconocido. Puede haberse creado recientemente, haberse introducido incorrectamente, haberse enviado al operador equivocado o no estar disponible temporalmente. No debe etiquetarse como perdido sin un proceso empresarial independiente y pruebas que lo respalden.

¿Cuándo vale la pena considerar una API de seguimiento multioperador?

Vale la pena evaluarla cuando tu aplicación debe admitir varios operadores o cuando mantener autenticaciones, esquemas, mapeos de estados y políticas de errores independientes generaría un trabajo operativo considerable. Compara los proveedores utilizando escenarios de envíos reales y verifica la información actual sobre operadores y características en su documentación oficial.

Fuentes

  • UPS Developer Portal — punto de acceso oficial a los productos de API de UPS, la configuración de aplicaciones, la autenticación y los recursos para desarrolladores.
  • UPS Tracking — servicio oficial de seguimiento de UPS y referencia de terminología.
  • 17TRACK Tracking API — página oficial del producto para evaluar una integración de seguimiento multioperador.
  • 17TRACK API Documentation — documentación oficial para desarrolladores sobre los detalles actuales de la API y los requisitos de integración.
Loading