API-Update: Template-Namen werden zu URL-sicheren Slugs

Kevin van Zonneveld

Mitgründer · Amsterdam, Niederlande · Bio anzeigen

Wir möchten Ihnen eine Änderung an unserer API mitteilen, die wir am 30. April 2020 vornehmen werden. An diesem Tag stellen wir alle Namen, die unsere Kundinnen und Kunden ihren Templates gegeben haben, auf ein URL-sicheres Format um. Hieß Ihr Template zum Beispiel bisher Video encode for Apple Devices, lautet der neue Name video-encode-for-apple-devices.

Durch diese Änderung können Sie Templates künftig über diesen URL-sicheren Namen ansprechen, den wir Slug nennen. Dadurch können Sie Ihre Assemblies so erstellen:

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

statt wie bisher nur über ihre ID:

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

Das macht Assembly Instructions direkt in Ihrem Code-Editor selbsterklärender und hilft, Fehler zu vermeiden, die bei UUIDv4 ohne Bindestriche wie a528022861cf4a0292ea96bd2b18efc1 leicht übersehen werden. Außerdem arbeiten wir an einer noch geheimen Funktion, die enorm davon profitieren wird, dass sich Templates über ihren Slug ansprechen lassen. Bleiben Sie gespannt!

Natürlich gibt es wie bei jeder Änderung einen Kompromiss: Wenn Sie Template-Slugs einsetzen, können Sie diesen Namen (sprich: Slug) nicht mehr ändern, ohne Ihre Integrationen zu beschädigen. Gehen Sie dabei entweder sorgfältig vor, oder – falls das für Ihren Anwendungsfall problematisch ist – verweisen Sie einfach weiterhin wie bisher auf Template IDs. Es sind keine Änderungen nötig.

Ist die Umstellung der Namen auf Slugs abwärtskompatibel?

Wir erwarten keine Probleme durch die Migration, da die menschenlesbaren Template-Namen (Video encode for Apple Devices) bis dahin nur von, nun ja, Menschen verwendet worden sein sollten. Transloadit bietet keine Funktionalität auf Basis dieser Namen, abgesehen davon, sie in Listen anzuzeigen und Menschen darin suchen zu lassen. Das funktioniert auch nach der Migration weiterhin. Tippen Sie: apple, und Sie erhalten video-encode-for-apple-devices, genau wie Sie zuvor Video encode for Apple Devices in Ihren Suchergebnissen erhalten hätten.

Das Einzige, was brechen könnte, ist Ihr eigener Automatisierungscode, falls Sie sich darin irgendwie auf Template-Namen verlassen. Sollte das bei Ihnen der Fall sein, empfehlen wir, das vor dem 30. April 2020 zu ändern, um Ausfälle zu vermeiden. Am besten verlassen Sie sich gar nicht auf Namen, sondern verwenden in Ihrem eigenen Code IDs, wenn Sie sicherstellen möchten, dass alles dauerhaft funktioniert.