Bonnes pratiques de l'API

Cet article contient les bonnes pratiques à appliquer pour interagir avec l'API de ZenVideo et l'utiliser.

Dans cet article, vous en saurez sur ce qui suit : 

• Réponses en cache
• Utilisation des filtres de champ
• Respect des limites de débit
• Éviter la récupération de données
• Utiliser uniquement nos API documentées publiquement

Réponses en cache

La plupart des métadonnées sur ZenVideo ne changent pas fréquemment (comme les noms des vidéos, les descriptions, le code d'intégration, etc.). Dans la mesure du possible, les développeurs doivent mettre ces réponses en cache et servir à partir du cache, en ne faisant des demandes à l'API que lorsque de nouvelles métadonnées sont nécessaires ou attendues. La mise en œuvre de paramètres tels que l'en-tête If-Modified-Since peut aider dans ce domaine. Pour en savoir plus, consultez l'article « Utiliser l'en-tête If-Modified-Since » disponible sur la page des développeurs.

Utilisation des filtres de champ

De nombreuses demandes adressées à ZenVideo renvoient une montagne de données, ce qui peut ne pas être efficace si vous n'avez besoin que d'une information spécifique. L'utilisation des paramètres de champ pour spécifier exactement ce dont vous avez besoin à partir de la réponse réduira la charge de travail sur nos serveurs et améliorera le temps de réponse de l'API. Pour en savoir plus, consultez l'article « Utiliser les paramètres de champ ». De plus, l'utilisation des paramètres de champ vous permettra de bénéficier d'une limite de débit plus élevée.

Respect des limites de débit

Nous appliquons des limites de débit afin de garantir une plateforme stable pour tous les développeurs. Si votre application dépasse la limite de débit, l'API renvoie un message d'erreur HTTP 429. Les développeurs doivent anticiper cette situation et cesser d'effectuer des demandes à l'API jusqu'à ce que l'interdiction de la limite de débit soit levée. Pour en savoir plus, consultez l'article « Travailler avec des limites de débit ». 

Éviter la récupération de données

Récupérer consiste à extraire des données d'un site web, souvent en chargeant une page web et en exécutant un script pour obtenir les données souhaitées de la page.

Plutôt que de recourir à cette méthode pour obtenir des données, les développeurs devraient utiliser l'une de nos API pour obtenir les mêmes données ; la mise en œuvre de notre API est plus facile et plus rapide. 

Si nous remarquons qu'un serveur récupère des données sur le site de ZenVideo et envoie un trafic excessif dans notre direction, l'adresse IP de ce serveur peut être bannie sans préavis. Si vous pensez que l'adresse IP de votre serveur a été bannie, contactez l'assistance en fournissant des informations supplémentaires. 

Utiliser uniquement nos API documentées publiquement

Les développeurs intrépides peuvent découvrir des méta-tags, des fichiers de configuration ou d'autres API qui servent à obtenir des données depuis ZenVideo. Bien que ces outils puissent être accessibles aux utilisateurs avertis, nous demandons aux développeurs de n'utiliser que les API publiques documentées sur le site développeur. Ces API internes ne sont pas destinées à être utilisées par des tiers et peuvent être modifiées à tout moment sans préavis.