Guide d’accès au RESTful API d’ActiveTrail
Le système ActiveTrail offre à ses utilisateurs de multiples options innovantes pour gagner en temps et en efficacité ! Certaines sociétés trouvent plus pratique de travailler avec leurs propres systèmes à l’aide d’une interface de programmation applicative (API), sans avoir recours à l’interface utilisateur (UI) d’ActiveTrail. En outre, certaines opérations doivent être intégrées par l’intermédiaire de systèmes externes, tels que le site Internet du client ou des systèmes de gestion des relations avec la clientèle (CRM), pour lesquels existe l’option API, permettant aux programmeurs de réaliser des opérations telles que la synchronisation de données à distance.
En utilisant RESTful API, vous pouvez automatiser tout ce qui peut être fait dans le système ActiveTrail. L’interface est intuitive, claire et facile à utiliser pour le programmeur. Alors, au travail !
Comment se connecter à RESTful API ?
Pour commencer à utiliser RESTful API, vous devez vous connecter au système d’ActiveTrail, puis cliquer sur « Compte » et « Paramètres », dans le coin supérieur gauche.
À partir de l’onglet « apps API » dans « Paramètres », vous pouvez créer un Access Token, une sorte de code personnel sécurisé pour activer la synchronisation API au système ActiveTrail, que vous pourrez ainsi relier à d’autres systèmes.
Pour créer votre Access Token, cliquez sur « Nouveau », ce qui entraînera l’ouverture de l’écran « apps API », à partir duquel vous pouvez créer le code :
Vous pouvez créer un nombre illimité d’Access Token, le code affecté s’appliquant à chaque fois à un système différent. Chaque code individuel peut être annulé, ce qui vous permet d’annuler le code d’accès d’un système, tout en continuant à travailler avec un autre système que cette opération n’affectera nullement.
Vous pouvez également spécifier des adresses IP autorisées ou une plage d’adresses IP autorisées pour un jeton d’accès.
Une fois l’Access Token créé, cliquez sur « Enregistrer ». Le code d’accès que vous avez créé apparaîtra dans une liste, dans l’onglet « apps API » (applications API):
Les webhooks (événements)
Dans le menu « Paramètres », à gauche de l’onglet « apps API », vous trouverez un autre onglet, appelé « Evénements » (webhooks en anglais). Il s’agit de mises à jour des données des destinataires au sein du système.
Les mises à jour peuvent être réalisées manuellement, par exemple lorsque vous mettez à jour votre liste de distribution, ou automatiquement, lorsqu’un nouvel abonné a rempli le formulaire d’inscription, lorsqu’un abonné a modifié ses données, etc.
Pour qu’ActiveTrail puisse se connecter à votre système, vous devez saisir votre adresse API dans la case prévue pour les adresses URL.
« Ajouter des paramètres » – Ajoutez des paramètres en fonction de votre API, lesquels seront envoyés lors de chaque contact avec votre API.
« Tester » – Envoyez un test pour vérifier si vous recevez des notifications de notre part.
Activetrail active le webhook et contacte votre API dans deux cas ; pour les modifier, mettez à jour l’URL de votre API dans la case prévue à cet effet.
- Modification du destinataire – lorsqu’il y a un changement des données du destinataire, ne résultant pas d’une modification manuelle effectuée à partir de l’interface ActiveTrail, mais due à une mise à jour externe (par le biais d’un formulaire d’inscription, d’une mise à jour d’API, d’une page d’atterrissage ou de n’importe quelle autre méthode non manuelle) ;
- Modification manuelle – lorsque les données de l’abonné sont mises à jour manuellement au sein de la plateforme Internet d’ActiveTrail.
L’accès par la documentation en ligne
L’accès à l’interface API d’ActiveTrail s’effectue on-line et il existe une documentation en ligne, comprenant des explications détaillées sur chaque fonction et son rôle !
Vous pouvez tester chacune des fonctions à partir du bouton « Test API » (tester l’API).
Chacune des tâches pouvant être effectuées à partir de l’interface utilisateur d’ActiveTrail peut également l’être depuis l’API. Vous pouvez utiliser toutes les fonctions, y compris notre système d’automatisation.
Il ne vous reste plus qu’à vous rendre sur la page de documentation et à commencer à travailler !