Prácticas recomendadas de API

Este artículo contiene las prácticas recomendadas para interactuar y utilizar la API de ZenVideo.

En este artículo, aprende sobre: 

• Respuestas en caché
• Usa filtros de campo
• Respeta los límites de frecuencia
• Evita el scraping
• Usa solo nuestras API documentadas públicamente

Respuestas en caché

La mayoría de los metadatos de ZenVideo no cambian con frecuencia (como los nombres de los videos, las descripciones, el código de inserción, etc.). Siempre que sea posible, los desarrolladores deberían almacenar en caché estas respuestas y trabajar desde caché, haciendo solicitudes a API solo cuando se necesiten o se esperen nuevos metadatos. La implementación de parámetros como If-Modified-Since-header (Si-Modificado-Desde-encabezado) pueden ayudar en esta área. Obtén más información en Uso del encabezado If-Modified-Since o en nuestra Página para desarrolladores. 

Usa filtros de campo

Muchas solicitudes a ZenVideo darán por resultado una gran cantidad de datos, lo que puede no ser eficiente si solo se necesita una pieza de información específica. Al usar el parámetro de campos para especificar exactamente lo que se necesita de la respuesta, se reducirá la carga de trabajo en nuestros servidores y aumentará el tiempo de respuesta de API. Obtén más información en Uso del parámetro de campos. El uso del parámetro de campos también te concederá un límite de velocidad más alto.

Respeta los límites de frecuencia

Hacemos cumplir los límites de frecuencia para garantizar una plataforma estable para todos los desarrolladores.Si tu aplicación supera el límite de frecuencia, API mostrará un error HTTP 429.Los desarrolladores deben prever esto y dejar de hacer solicitudes a API hasta que se haya levantado la prohibición del límite de frecuencia.Obtén más información en Trabajar con límites de frecuencia. 

Evita el scraping

El scraping es la acción de extraer datos de un sitio web, a menudo, cargando una página web y ejecutando una secuencia de comandos para obtener los datos de la página que se desean.

En lugar de hacer scraping para obtener datos, los desarrolladores deberían utilizar una de nuestras API para obtener los mismos datos; la implementación de nuestra API es más fácil y rápida que hacer scraping en el sitio. 

Si se descubre que un servidor hace scraping en ZenVideo y envía un exceso de tráfico hacia nosotros, podrá prohibirse la dirección IP de ese servidor sin previo aviso.Si crees que la dirección IP de tu servidor se ha prohibido, comunícate con el equipo de asistencia con más información. 

Usa solo nuestras API documentadas públicamente

Los desarrolladores más audaces pueden descubrir metaetiquetas, archivos de configuración u otras API utilizadas para obtener datos de ZenVideo. Si bien pueden ser accesibles para usuarios expertos, pedimos que los desarrolladores usen solo API públicas documentadas en el sitio para desarrolladores. Estas API internas no están pensadas para el uso de terceros y pueden cambiar en cualquier momento sin previo aviso.