API de plataforma digital: cambios importantes

Nuestra API cambia continuamente. La gran mayoría de los cambios simplemente agregan nuevas funcionalidades, pero ocasionalmente introducimos cambios importantes que pueden requerir que ajuste su integración.

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

Importante

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

Cambios importantes

Los siguientes tipos de cambios se consideran 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

Cuando introduzcamos 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 sobre estos cambios y cómo llegar correctamente a cada versión durante el período de cambios importantes. Si su cuenta de usuario está habilitada para la API, recibirá automáticamente comunicaciones de cambios importantes.

Ejemplos de cambios no importantes

Los siguientes tipos de cambios no se consideran 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
  • Obsolescencia de un campo sin quitarlo
  • Reducción o aumento del número de informes simultáneos permitidos
  • Anexar un nuevo campo a una de nuestras fuentes de datos de nivel de registro
  • Cambiar el orden de los campos de un objeto, de los objetos de una matriz, etc