Política sobre las API públicas
Última actualización: 31 de enero de 2024
Nota importante: El idioma oficial de todos los contratos de Tulip y demás documentos legales es el inglés, que prevalecerá sobre cualquier otro idioma utilizado en cualquier documento traducido.
Tulip Ofrece un conjunto de API públicas que permiten a los usuarios interactuar mediante programación con la plataforma Tulip . Tulip organiza sus API en grupos denominados «espacios de nombres», que representan, a grandes rasgos, las áreas funcionales del producto Tulip (por ejemplo, Apps, Automatizaciones, Usuarios, etc.). A cada espacio de nombres de API se le asigna una etiqueta denominada «versión» (del tipo «v1», «v2», «v3», etc.). Todos los puntos finales de la API contenidos en un espacio de nombres se versionan conjuntamente como una unidad.
A medida que Tulip desarrolla nuevas funciones, mejora las ya existentes y corrige problemas, es posible que publiquemos actualizaciones de estas API que modifiquen una versión existente de la API o introduzcan una nueva versión de la misma (las reglas que determinan qué tipos de cambios requieren una nueva versión se describen en la sección «Estabilidad» ). Las actualizaciones de las API se publican con cada lanzamiento de la plataforma Tulip y se describirán en las notas de lanzamiento de Tulip. En cualquier momento pueden estar disponibles varias versiones de un espacio de nombres determinado. Se recomienda a los usuarios que utilicen la versión más actualizada de las API, aunque las versiones anteriores se mantienen durante un tiempo (consulte la sección «Soporte» para obtener más información sobre el ciclo de vida de las versiones). Los derechos de uso de las API de Tulip se rigen por lo establecido en el Acuerdo de licencia de la API deTulip.
Estabilidad
Cuando una versión de un espacio de nombres de la API de Tulip se considera estable, Tulip puede publicar cambios en la API, pero dichos cambios deben ser compatibles con versiones anteriores. En el contexto de las API de Tulip , un cambio se considera generalmente compatible con versiones anteriores si no afecta al funcionamiento de las integraciones existentes que utilizan dicha API. En concreto, se consideran compatibles con versiones anteriores los siguientes tipos de cambios:
- Añadir un nuevo punto final a un espacio de nombres.
- Añadir un campo opcional en el cuerpo de la solicitud, un parámetro de consulta o un encabezado HTTP, de tal forma que el significado de los demás campos, parámetros o encabezados no se vea alterado cuando se omita dicho campo opcional. Ten en cuenta que, por lo general, los campos no reconocidos del cuerpo de la solicitud se ignoran, por lo que un campo que antes carecía de significado (y que no provocaba ningún error) podría adquirir significado en una versión posterior sin que ello se considere un cambio que rompa la compatibilidad.
- Añadir un tipo de contenido para el cuerpo de la solicitud aceptado a un punto final. Si el nuevo tipo de contenido corresponde a datos estructurados (JSON, YAML, CSV, etc.), debe ajustarse a la estructura documentada del cuerpo de la solicitud. Si el nuevo tipo de contenido corresponde a datos no estructurados (imágenes, vídeos, PDF, texto sin formato u otros datos binarios), debe cumplir con las restricciones documentadas en la descripción del cuerpo de la solicitud.
- Modificar el tipo o las reglas de validación de un campo del cuerpo de la solicitud, un parámetro de consulta o un encabezado HTTP, de modo que todos los valores que antes eran válidos sigan considerándose válidos.
- Añadir un nuevo campo en el cuerpo de la respuesta o un nuevo encabezado HTTP.
- Añadir un nuevo código de estado HTTP de respuesta de error (4xx, 5xx).
- Eliminar posibles valores del tipo de un campo del cuerpo de la respuesta o de un encabezado HTTP, de tal forma que el significado de los demás campos o encabezados de la respuesta no se vea alterado.
- Modificar la documentación de un tipo, un código de error, un campo o un punto final de forma que no afecte al comportamiento de la API.
- Modificar el texto de la descripción del error que aparece en las respuestas de error.
- Modificar los nombres que se muestran u otro contenido textual de cualquier recurso definido en « Tulip ».
- Modificar los límites de frecuencia, tamaño o número de recursos aplicados a los terminales.
- Corrección de un error para que el comportamiento real de un punto final se ajuste al comportamiento descrito en la documentación.
- Solucionar una vulnerabilidad de seguridad por cualquier medio necesario, incluso con cambios que, en otras circunstancias, se considerarían incompatibles. En caso de que Tulip tenga que publicar una corrección de seguridad crítica que implique un cambio en la API que provoque incompatibilidades, intentaremos colaborar con nuestros clientes para que actualicen sus integraciones y así evitar, en la medida de lo posible, el tiempo de inactividad.
- Añadir, eliminar o modificar cualquier punto final, parámetro o tipo que no esté documentado públicamente.
En ocasiones, Tulip puede verse en la necesidad de publicar un cambio en una API que no sea compatible con versiones anteriores. Esto se conoce como «cambio que rompe la compatibilidad » o «cambio incompatible con versiones anteriores ». Tulip solo publicará cambios que rompan la compatibilidad en las API estables en una nueva versión de su espacio de nombres de API (con la excepción de las correcciones de seguridad críticas, tal y como se ha descrito anteriormente). Se consideran incompatibles con versiones anteriores los siguientes tipos de cambios:
- Eliminar un punto final de un espacio de nombres.
- Eliminar un campo del cuerpo de una solicitud, un parámetro de consulta o un encabezado HTTP.
- Eliminar el tipo de contenido del cuerpo de una solicitud aceptada de un punto final.
- Cambiar el tipo de contenido del cuerpo de la respuesta de un punto final.
- Modificar el tipo o las reglas de validación de un campo del cuerpo de la solicitud, un parámetro de consulta o un encabezado HTTP, de modo que algunas entradas dejen de considerarse válidas.
- Modificar el valor por defecto de un campo opcional del cuerpo de la solicitud, un parámetro de consulta o un encabezado HTTP.
- Añadir un campo obligatorio en el cuerpo de la solicitud, un parámetro de consulta o un encabezado HTTP.
- Añadir un campo opcional en el cuerpo de la solicitud, un parámetro de consulta o un encabezado HTTP de tal forma que también cambie el significado de cualquier otro campo, parámetro o encabezado.
- Añadir valores posibles al tipo de un campo del cuerpo de la respuesta o de un encabezado HTTP.
- Añadir un nuevo código de estado HTTP de respuesta de éxito (1xx, 2xx, 3xx).
- Eliminar un campo del cuerpo de la respuesta o un encabezado HTTP.
- Modificar de forma significativa la semántica o la funcionalidad documentadas de un punto final, aunque la interfaz no haya cambiado.
Límites
La API de Tulip aplica diversos tipos de límites con el fin de proteger los recursos compartidos (servidores de la API, bases de datos, etc.) frente a una carga excesiva que pueda afectar a la calidad del servicio para otros usuarios y clientes. Entre dichos límites se incluyen (estos son solo ejemplos ilustrativos):
- Límites de frecuencia: Por defecto, un cliente determinado no puede realizar solicitudes a un punto final concreto más de un número determinado de veces por segundo.
- Límites de tamaño: El nombre de un recurso no puede superar un número determinado de caracteres, ni el tamaño de un archivo subido puede superar un tamaño determinado.
- Límites en el número de recursos: No se pueden crear más de un número determinado de espacios de trabajo.
Aunque Tulip puede ofrecer documentación sobre algunos de estos límites, estos no se consideran parte de la API estable y pueden cambiar en cualquier momento en función de las condiciones de carga actuales, la evolución de los requisitos del producto, las preferencias de los usuarios y otros factores. Los clientes deben utilizar la información proporcionada por las respuestas de la API de Tulip (códigos de estado, códigos de error y campos de error) para gestionar los errores relacionados con los límites. Tulip se reserva el derecho a desactivar a aquellos clientes que incumplan repetidamente estos límites.
Asistencia
Tulip Ofrece soporte para sus API, similar al que ofrecemos para otros productos de Tulip . El soporte completo incluye el mantenimiento de la documentación, la respuesta a preguntas, la resolución de problemas, la publicación de correcciones de errores y la publicación de parches de seguridad para estas API. Tulip no ofrece soporte para API no documentadas. El nivel de soporte que Tulip ofrece para una versión pública del espacio de nombres de una API varía en función de cómo se designe en la documentación de la API:
- Alpha - Tulip ofrecerá un soporte limitado para esta API y podrá introducir cambios que afecten a la compatibilidad de la misma en cualquier momento.
- Beta: Tulip es totalmente compatible con esta API, pero puede introducir cambios que afecten a la compatibilidad con esta API en cualquier momento. Comunicaremos cualquier cambio de este tipo a los clientes de la versión Beta.
- Estable: Tulip es totalmente compatible con esta API y la considera estable, tal y como se define en la sección «Estabilidad ».
- Obsoleta: Tulip tiene previsto eliminar esta API en un futuro próximo. Tulip ofrecerá compatibilidad total con esta API, pero los usuarios deben planificar la actualización de cualquier integración que la utilice a una versión más reciente de la API; Tulip proporcionará orientación al respecto. Por lo general, las API obsoletas no recibirán actualizaciones, salvo que se trate de correcciones críticas de seguridad o de errores.
- Fin del soporte técnico: Tulip no ofrecerá ningún tipo de soporte técnico para esta API, incluidas las correcciones de seguridad críticas. Las API para las que no se ofrece soporte técnico pueden dejar de funcionar en cualquier momento sin previo aviso.
Los espacios de nombres de API estables se mantendrán estables durante al menos un ciclo de lanzamiento LTS antes de que se marquen como obsoletos. Los espacios de nombres de API obsoletos seguirán recibiendo soporte durante al menos dos ciclos de lanzamiento LTS antes de que se marquen como sin soporte.