Skip to main content
YCloud utiliza versiones de URI para cambios incompatibles de la API. La URL base actual de la API es https://api.ycloud.com/v2.

​
Cambios compatibles con versiones anteriores

Su integración debe admitir estos cambios dentro de la misma versión de la API:
  • Nuevos recursos de la API.
  • Nuevos parámetros de solicitud opcionales en operaciones existentes.
  • Nuevas propiedades de respuesta o un orden diferente de las propiedades de respuesta.
  • Cambios en la longitud o formato de cadenas opacas, incluidos los ID de objeto, mensajes de error y otras cadenas legibles por humanos.
  • Nuevos valores de enumeración (enum), incluidos nuevos tipos de eventos de Webhook.
Ignore las propiedades de respuesta que no utilice. Gestione tipos de eventos desconocidos sin que falle todo el receptor de su Webhook. Utilice códigos de error documentados para el flujo de control en lugar de buscar coincidencias con un mensaje de error legible por humanos.

​
Almacenar identificadores opacos

Trate los ID de objeto como cadenas opacas que distinguen entre mayúsculas y minúsculas. No infiera el significado a partir de la longitud de un ID o de un prefijo como evt_; los prefijos se pueden añadir o eliminar. Los ID de objeto generados por YCloud no superan los 255 caracteres. Permita esa longitud total en su almacenamiento. Por ejemplo, una columna de MySQL puede utilizar VARCHAR(255) COLLATE utf8_bin para conservar las comparaciones que distinguen entre mayúsculas y minúsculas.

​
Cambios incompatibles

Un cambio incompatible utiliza una versión diferente en el URI de solicitud. Por ejemplo:
Utilice la versión documentada para su integración. No cambie el segmento de versión sin revisar los contratos de solicitud, respuesta y Webhook. Consulte el registro de cambios de la API para ver los cambios históricos.