Control de versiones

La versión de la Partner API se indica en la URL. La versión actual es:

https://partner-api.performancehub.co/partner/v1/

Política de cambios

El Performance Hub procura hacer cambios aditivos y compatibles con versiones anteriores siempre que sea posible.

Ejemplos de cambios compatibles con versiones anteriores:

• Agregar un nuevo campo opcional a una solicitud.
• Agregar un nuevo campo a una respuesta.
• Agregar un nuevo endpoint.
• Agregar un nuevo valor de enumeración cuando se espera que los clientes gestionen valores desconocidos.
• Mejorar los mensajes de validación sin cambiar el contrato de códigos de estado.

access_time_windows y access_time_windows_revision son campos adicionales de la solicitud de miembros. Los clientes existentes que los omiten mantienen sin cambios la instantánea guardada de Access Time Windows. Esta regla de omisión preserva la compatibilidad con las inserciones o actualizaciones parciales; omitirlos no equivale a enviar una matriz vacía.

Ejemplos de cambios incompatibles:

• Eliminar o cambiar el nombre de un campo.
• Cambiar el tipo de un campo.
• Hacer obligatorio un campo de solicitud opcional.
• Eliminar un endpoint.
• Cambiar el significado de un código de estado existente o de un reason específico de un dominio.

Elementos obsoletos

Cuando sea necesario un cambio incompatible, el Performance Hub evitará, siempre que sea posible, modificar la versión existente. En su lugar, introduciremos una nueva versión o una ruta de migración y comunicaremos el cambio a los socios afectados.

Los avisos de obsolescencia pueden incluir:

• Una entrada en el registro de cambios.
• Una comunicación directa con los socios.
• Notas en la Partner Console.
• Pautas de migración en la documentación.

Recomendaciones para los clientes

Crea clientes que toleren los cambios aditivos:

• Ignora los campos de respuesta que no uses.
• Trata los valores de enumeración desconocidos como no admitidos en lugar de provocar un error.
• Evita las comprobaciones estrictas de igualdad de las respuestas.
• Registra los valores no reconocidos para poder actualizar tu integración de forma deliberada.

En las particiones de miembros con revisiones, como Access Time Windows, conserva la revisión enviada y la carga útil normalizada hasta conocer el resultado. Reutilizar una revisión con contenido modificado genera un conflicto, mientras que repetir el mismo contenido es idempotente. Consulta Access Time Windows.

Especificaciones OpenAPI

Usa las especificaciones OpenAPI publicadas para generar clientes, validar solicitudes y hacer un seguimiento de los cambios en la estructura de la API a lo largo del tiempo.

Consulta Especificaciones OpenAPI.