Versiones, Sandbox y soporte

Los cambios aditivos se incorporan en v1 sin previo aviso; los cambios incompatibles pasan a v2, y el entorno Sandbox tiene su propia URL base y sus propias claves.

Versiones

La versión es el segmento de ruta: /api/v1/….

Los cambios aditivos se incorporan en v1 sin previo aviso. Campos opcionales nuevos en las solicitudes, claves nuevas en las respuestas, endpoints nuevos, límites de campo más amplios y más valores en una enumeración. Diseñe su cliente para que ignore las claves que no reconoce.

Los cambios incompatibles pasan a v2. Eliminar o cambiar el nombre de un campo, cambiar un tipo, hacer más estricto un campo obligatorio o cambiar un código de estado. Cuando esto ocurre, /api/v1 sigue funcionando durante un período de obsolescencia publicado, y el registro de cambios indica cuándo termina.

Todos los cambios, sean aditivos o no, se registran con fecha en el registro de cambios. La especificación de OpenAPI se genera a partir del código de TrackFlo con cada lanzamiento, por lo que la referencia nunca está desactualizada ni se adelanta a lo que acepta la API.

Validación de campos

La Ingestion API rechaza las claves desconocidas de nivel superior y los valores no válidos con 400 antes del procesamiento. Los campos problemáticos se indican en details, tanto si son desconocidos como si faltan o no son válidos. Corrija la solicitud antes de volver a intentarlo; no debe volver a enviar sin cambios una solicitud rechazada. Se aceptan algunos valores que pueden convertirse al tipo esperado, pero se rechazan los tipos no válidos. Envíe solo los campos que se indican en la referencia y con los tipos especificados.

Sandbox

TrackFlo cuenta con un entorno de desarrollo independiente, con su propia URL base y sus propias claves. Solicite una clave de Sandbox durante la incorporación, dirija primero su integración a ese entorno y cambie la URL base y la clave a las de producción cuando esté listo. Los usuarios de producción no pueden ver los datos de Sandbox.

Soporte

• Preguntas sobre la integración y solicitudes de claves: su contacto de TrackFlo.

• Un 500: vuelva a intentarlo con una espera incremental; si el problema persiste, envíe el error_id del 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.

• Una carga que no aparece en el tablero o una solicitud rechazada cuyo motivo no puede explicar: abra Integration QA en la aplicación de TrackFlo y busque la carga.