Introducción
La suscripción de número de rastreo de visibilidad integrada avanzada está diseñada para que los suscriptores de la visibilidad integrada avanzada administren sus proyectos de webhook basados en el número de rastreo y realicen operaciones relacionadas con ellos, como agregar nuevos números de rastreo y editar o ver los detalles del trabajo mediante puntos finales de API.
Nota:
- Debes tener acceso de administrador o colaborador para tu proyecto de visibilidad integrada avanzada
- Para obtener más información sobre la visibilidad integrada avanzada y sus funciones, visita la página Documentación sobre visibilidad integrada avanzada.
Beneficios de la suscripción de número de rastreo de visibilidad integrada avanzada
Los beneficios de la suscripción de número de rastreo de visibilidad integrada avanzada son los siguientes:
- Puedes actualizar y administrar fácilmente los números de rastreo de tu proyecto de visibilidad integrada avanzada utilizando los puntos finales de API.
- Esta API te permite asociar varios números de rastreo a tu proyecto en una única transacción de API, en lugar de asociar cada número de rastreo uno por uno.
- Puedes enviar solicitudes de API de forma consecutiva y ver los detalles del registro de éxito/fracaso de estas solicitudes.
Cómo funciona la suscripción de número de rastreo de visibilidad integrada avanzada
Utiliza los siguientes puntos finales para gestionar tu proyecto de visibilidad integrada avanzada:
Solo se puede acceder a esta API a través de la descripción general de tu proyecto, como se muestra en la captura de pantalla anterior.
Asociación de números de rastreo
Utiliza este punto final para activar un trabajo asincrónico para asociar uno o varios números de rastreo a un proyecto específico de visibilidad integrada avanzada.
La información de entrada requerida para esta solicitud es:
- Acción: especifica la acción que se realizará cuando envíes la solicitud. Ejemplo: AÑADIR
- Detalles del número de rastreo: especifica el número de rastreo
Puedes asociar un máximo de 1000 números de rastreo en una sola solicitud. Una respuesta exitosa a esta solicitud arrojará el ID del trabajo, el estado actual del trabajo y la marca de tiempo de creación y finalización del trabajo. Este jobId se puede utilizar más adelante para comprobar el estado del trabajo asincrónico.
Número de rastreo Estado del trabajo
Utiliza este punto final para obtener el estado de un trabajo asincrónico (una o más solicitudes consecutivas en cola) o el estado de todos los trabajos enviados.
La información de entrada requerida para esta solicitud es:
- ID de trabajo: especifica el ID de trabajo cuyo estado deseas recuperar.
Nota: La ID del trabajo es una entrada opcional para este punto final. Si no especificas el ID del trabajo, obtendrás el estado de todos los trabajos enviados.
Una respuesta exitosa a esta solicitud arrojará el ID del trabajo, el estado actual del trabajo y la marca de tiempo de creación y finalización del trabajo. La respuesta mostrará el estado actual de los trabajos. Además, la respuesta también contendrá mensajes de éxito, errores o advertencias para que los usuarios los vean y solucionen los problemas según corresponda.
- Si el estado del trabajo se muestra como COMPLETADO, significa que todos los números de rastreo se validaron y procesaron exitosamente.
- El estado COMPLETADO implica que los números de rastreo se validaron y procesaron correctamente. No implica que todos los números de rastreo se hayan agregado correctamente al proyecto de visibilidad integrada avanzada.
- Si intentas asociar varios números de rastreo y solo algunos de ellos se asocian, pero el resto no, incluso entonces el estado del trabajo se actualizará como COMPLETADO. Para confirmar el estado de cada número de rastreo en la solicitud del asociado, se debe descargar el informe por lotes.
- Si el estado del trabajo se muestra como FALLIDO, esto implica que debido a diversos motivos o fallas graves, la solicitud no se pudo procesar y el usuario debe volver a intentarlo.
Nota:
A continuación se detallan los estados y sus respectivas descripciones:
| ESTADO DEL TRABAJO | DESCRIPCIÓN |
|---|---|
ENVIADO |
El trabajo se envía al sistema después de todas las validaciones básicas y se procesará de forma asincrónica. |
ACEPTADO |
Se acepta el trabajo y se pondrá en cola. |
NO ACEPTADO |
El trabajo no se acepta debido a una falla interna o falta de disponibilidad del sistema; el usuario debe volver a intentarlo. |
EN COLA |
El trabajo está en cola para ser procesado y el procesamiento comenzará en cualquier momento. |
EN CURSO |
El trabajo se inició y está en progreso. |
COMPLETADO |
El trabajo se completó y el informe de importación o el archivo de exportación están disponibles para que el usuario los descargue. |
FALLIDO |
El trabajo falló por varios motivos y el usuario debe intentarlo nuevamente. |
Detalles del trabajo del número de rastreo
Utiliza este punto final para descargar el informe JSON de un trabajo asincrónico que esté en estado COMPLETADO.
La información que debe ingresarse en relación con esta solicitud es:
- ID de trabajo: especifica el ID de trabajo cuyo estado deseas recuperar.
Nota:
- El ID del trabajo es una entrada obligatoria para este punto final.
- Puedes descargar el informe de un solo trabajo asincrónico a la vez.
- Si el trabajo no está COMPLETADO e intentas descargar el informe, se mostrará un mensaje de error.
La respuesta exitosa a esta solicitud te proporciona el informe del trabajo en formato JSON.
Normas comerciales
- Se puede asociar un máximo de 1000 números de rastreo de envío a un proyecto de visibilidad integrada avanzada en cada solicitud.
- No hay límite en los números de rastreo máximos que puedes asociar con un proyecto de visibilidad integrada avanzada determinado.
- Cualquier número de rastreo asociado se desvinculará después de 40 días de un proyecto de visibilidad integrada avanzada determinado.
- Cualquier estado y detalles de ID de trabajo creados no estarán disponibles después de 90 días para un proyecto de visibilidad integrada avanzada determinado.
- La información de rastreo segura, como la dirección del destinatario y la firma del destinatario, no estará disponible a través de la suscripción al número de rastreo de visibilidad integrada avanzada.
Response