Mise à jour de l’API : noms de Template en slugs compatibles URL

Kevin van Zonneveld

Cofondateur · Amsterdam, Pays-Bas · Afficher la bio

Nous souhaitons vous informer d’une modification de notre API que nous effectuerons le 30 avril 2020. Ce jour-là, nous convertirons tous les noms que nos clients ont donnés à leurs Templates dans un format compatible URL. Si, par exemple, votre Template s’appelait auparavant Video encode for Apple Devices, son nouveau nom sera video-encode-for-apple-devices.

Cette modification permettra de faire référence aux Templates par ce nom compatible URL, que nous appelons un slug. Vous pourrez ainsi créer vos Assemblies comme ceci :

{
  "params": {
    "template_id": "video-encode-for-apple-devices"
  }
}

au lieu de les désigner uniquement par leur ID, comme auparavant :

{
  "params": {
    "template_id": "a528022861cf4a0292ea96bd2b18efc1"
  }
}

Les Assembly Instructions deviennent ainsi plus explicites directement dans votre éditeur de code, et cela peut aider à éviter des erreurs qui passent facilement inaperçues avec des UUIDv4 sans tirets comme a528022861cf4a0292ea96bd2b18efc1. Nous préparons également une fonctionnalité, encore secrète, qui tirera grandement parti de la possibilité de faire référence aux Templates par leur slug. Restez à l’écoute !

Bien entendu, comme pour tout changement, il y a un compromis : si vous commencez à adopter les slugs de Template, vous ne pourrez plus modifier ce nom (comprendre : slug) sans casser vos intégrations. Il convient donc soit de procéder avec précaution, soit, si cela pose problème pour votre cas d’usage, de simplement continuer à faire référence aux ID de Template comme vous le faites déjà. Aucune modification n’est nécessaire.

La conversion des noms en slugs est-elle rétrocompatible ?

Nous ne prévoyons aucune casse liée à la migration puisque, jusqu’à cette date, les noms de Template lisibles par un humain (Video encode for Apple Devices) ne devaient être utilisés que par, eh bien, des humains. Transloadit ne propose aucune fonctionnalité basée sur ces noms, si ce n’est leur affichage dans des listes et la possibilité pour les humains d’y effectuer des recherches. Cela continuera de fonctionner après la migration. Saisissez apple et vous obtiendrez video-encode-for-apple-devices, exactement comme vous auriez obtenu Video encode for Apple Devices dans vos résultats de recherche.

La seule chose qui pourrait poser problème, c’est que votre propre code d’automatisation s’appuie d’une manière ou d’une autre sur les noms de Template. Si c’est votre cas, nous vous recommandons de modifier cela avant le 30 avril 2020 pour éviter toute casse. Le mieux est de ne pas vous fier du tout aux noms et d’utiliser plutôt des ID dans votre propre code si vous voulez vous assurer que tout fonctionnera pour toujours.