Versionado, sandbox y soporte
Actualizado hoy
Los cambios aditivos se publican en v1 sin previo aviso, los cambios incompatibles pasan a v2 y el sandbox tiene su propia URL base y sus propias claves.
Versionado
La versión es el segmento de la ruta: /api/v1/….
Los cambios aditivos se publican en v1 sin previo aviso. Nuevos campos opcionales en las solicitudes, nuevas claves en las respuestas, nuevos endpoints, límites de campo más amplios y más valores en una enumeración. Configure su cliente para ignorar las claves que no reconozca.
Los cambios incompatibles pasan a v2. Eliminar o cambiar el nombre de un campo, cambiar un tipo, hacer más restrictivo un campo obligatorio o cambiar un código de estado. Cuando eso sucede, /api/v1 sigue funcionando durante el periodo de obsolescencia publicado, y el registro de cambios indica cuándo termina.
Todos los cambios, sean aditivos o no, reciben una entrada con fecha en el registro de cambios. La OpenAPI spec se genera a partir del código de TrackFlo en cada versión, por lo que la referencia aquí nunca está por delante ni por detrás de lo que acepta la API.
Un cambio planificado
La validación de campos se encuentra en un periodo en el que solo genera advertencias. Actualmente se acepta un cuerpo con una clave desconocida o un tipo incorrecto, y se registra en el lado de TrackFlo. En breve se rechazará con 400 y se indicará en error el campo problemático. La referencia ya refleja el comportamiento estricto: envíe solo los campos que aparecen en ella, con los tipos indicados.
Sandbox
TrackFlo mantiene un entorno de desarrollo independiente, con su propia URL base y sus propias claves. Solicite una clave de sandbox durante la incorporación, dirija allí primero su integración y cambie la URL base y la clave a producción cuando esté listo. Los datos del sandbox no son visibles para los usuarios de producción.
Soporte
Preguntas sobre la integración y solicitudes de claves: su contacto de TrackFlo.
Un
500: reintente con un intervalo progresivo; si el problema persiste, envíe elerror_iddel cuerpo de la respuesta.Un campo incorrecto o ausente en una carga: primero, compare el cuerpo de la solicitud que envió con la referencia; TrackFlo almacena lo que recibe.