Compartir a través de

Digital Platform API: cambios importantes

  • Artículo

Nuestra API está cambiando continuamente. La gran mayoría de los cambios simplemente agregan nueva funcionalidad, pero en ocasiones presentamos cambios importantes que pueden requerir que ajuste la integración.

En esta página se explica qué cambios califican como cambios importantes en nuestra API. También proporciona ejemplos de cambios que no califican como cambios importantes.

Importante

Nos reservamos el derecho de corregir errores, ajustar la funcionalidad para cumplir con nuestras directivas y obligaciones legales de parte del servicio , y cambiar las características y los productos en alfa y beta sin previo aviso.

Cambios importantes

Los siguientes tipos de cambios califican como cambios importantes:

  • Eliminación de un campo
  • Cambio de un campo de no obligatorio a obligatorio
  • Adición de nuevas reglas de validación
  • Modificación del tipo de datos de un campo (por ejemplo, matriz de identificadores convertidos en matriz de objetos)
  • Modificación de la limitación de solicitudes
  • Reducción del número de objetos devueltos por las respuestas

Al introducir un cambio importante en nuestra API, admitiremos dos versiones de la API en producción, una con y otra sin el cambio importante, durante 60 días. Además, notificaremos a los usuarios de la API estos cambios y cómo llegar correctamente a cada versión durante el período de cambios importantes. Si la cuenta de usuario está habilitada para la API, recibirá comunicaciones de cambio importantes automáticamente.

Ejemplos de cambios no importantes

Los siguientes tipos de cambios no califican como cambios importantes. Tenga en cuenta que esta lista no es exhaustiva; estos son solo algunos ejemplos de cambios no importantes.

  • Adición de un nuevo campo no obligatorio
  • Adición de un nuevo servicio
  • Adición de métricas o dimensiones a los informes
  • Adición de un nuevo tipo de informe
  • Desuso de un campo sin quitarlo
  • Reducción o aumento en el número de informes simultáneos permitidos
  • Anexar un nuevo campo a una de nuestras fuentes de distribución de datos de nivel de registro
  • Cambio en el orden de los campos de un objeto, objetos de una matriz, etc.