Réorganisation de l'API Reference

Introduction

L'API d'Actito est composée de deux versions qui co-existent avec de petites différences de format : V4 et V5. Depuis 5 ans, de nouvelles opérations ont été développées dans la V5, dont la philosophie était d'améliorer la cohérence des formats mais pas de remplacer complètement la version précédente.

Pour améliorer sa clarté et sa fonctionnalité, nous avons réorganisé la structure de l'API Actito, en passant de la distinction actuelle entre V4 et V5 à une catégorisation plus intuitive.

Désormais, un développeur qui a besoin de déclencher un scénario n'a plus besoin de vérifier si l'opération appropriée se trouve dans l'API 'Scénarios V4' ou 'Scénarios V5' : il n'y a qu'une seule catégorie 'Scénarios'.

Cette re-catégorisation implique un petit changement dans l'URL de toutes les opérations de l'API Actito.

Quels sont les changements ?

L'URL de toutes les opérations de l'API a été mise à jour pour inclure la catégorie de l'API dans le path, avant la version. Par exemple :

• https://api3.actito.com/v4/entity/{entity}/mail devient https://api3.actito.com/email-campaigns/v4/entity/{entity}/mail
• https://api.actito.com/v5/entities/{entity}/profile-tables devient https://api.actito.com/profile-table-structure/v5/entities/{entity}/profile-tables

Seule l'URL des appels est affectée. Leur scope, les paramètres ou le contenu de leur corps restent identiques.

Les URL existantes continueront à fonctionner jusqu'en juin 2025.

note

Les spécifications OAS téléchargeables ont également été mises à jour.

Que faut-il faire ?

Vos appels API devront être mis à jour vers le nouveau schéma d'URL avant la fin de juin 2025.

Cela signifie que jusqu'à cette date, toutes les anciennes URL continueront à fonctionner comme d'habitude.

En tant que marketeur, nous vous invitons à vérifier votre utilisation actuelle de l'API Actito avec votre équipe technique ou vos partenaires et à planifier la mise à jour de manière appropriée.

En tant que développeur, vous devrez mettre à jour vos appels API vers le nouveau schéma d'URL avec le "préfixe" de catégorie API.

Après juin 2025, seules les nouvelles URL resteront opérationnelles.

astuce

Nous conseillons fortement de préparer tout nouveau développement avec les nouvelles URL, comme documenté partout dans le portail des développeurs à partir de maintenant.

Comment les développeurs peuvent-ils mettre à jour leurs appels ?

En fonction de leur code, les développeurs peuvent devoir mettre à jour un paramètre ou faire un simple "chercher et remplacer" pour mettre à jour le path de leurs appels.

Pour faciliter cette opération, vous trouverez ci-dessous une correspondance entre l'ancienne et la nouvelle URL de toutes les opérations.

info

Téléchargez le fichier de correspondance ICI.

Pourquoi faisons-nous ce changement ?

L' API Reference existante basée sur la version peut prêter à confusion. Comme les deux versions coexistent, les développeurs qui veulent envoyer des données ou déclencher des campagnes via l'API Actito ont souvent besoin d'un mélange d'opérations V4 et V5, ce qui ne permet pas de savoir quelle version utiliser.

En réorganisant l'API Rerefence en catégories business, nous visons à simplifier ce processus.

Néanmoins, en raison de leur différence de format, le concept de version reste visible dans le path des appels. Les deux versions continuent à co-exister et seules les opérations qui existent dans les deux versions seront éventuellement supprimées dans l'ancienne version.

Est-ce que quelque chose d'autre change ?

Cette réorganisation signifie que les opérations, quelle que soit leur version, relèveront désormais de la même catégorie d'API. Un nombre limité d'opérations sont actuellement en doublon et existent à la fois dans les versions V4 et V5.

Ces opérations V4 en doublon sont dépréciées en faveur de leurs homologues V5, leur date de fin de service étant référencée dans le calendrier de maintenance.

Encore une fois, il n'est pas prévu de supprimer entièrement la V4. Cependant, le maintien d'opérations identiques dans les deux versions est redondant.

Nous recommandons vivement aux développeurs de mettre à jour leur code pour utiliser les nouvelles opérations en même temps qu'ils mettent à jour les URLs.