Avec l'API REST d'ActiveTrail, vous pouvez synchroniser les contacts, les groupes et les statistiques de campagne avec vos propres systèmes, envoyer des campagnes et des messages opérationnels, et gérer des automations. Ce guide présente les bases à connaître avant votre premier appel.
L'API s'adresse aux développeurs et à toute personne à l'aise avec du code personnalisé ou des intégrations REST. Pour chaque point de terminaison, consultez les guides de référence de l'API de cette section ou la documentation de l'API ActiveTrail, où vous pouvez aussi tester des appels avec vos propres données.
URL de base et ressources
Toutes les requêtes sont envoyées à https://webapi.mymarketing.co.il/api/. Les ressources sont des noms, comme groups ou contacts, et chaque élément a son propre ID :
GET https://webapi.mymarketing.co.il/api/groupsrenvoie vos groupes.GET https://webapi.mymarketing.co.il/api/groups/1234renvoie le groupe dont l'ID est 1234.
Authentification
Envoyez votre clé API dans un en-tête nommé Authorization avec chaque requête :
curl -X GET "https://webapi.mymarketing.co.il/api/groups" \
-H "Authorization: YOUR_API_KEY"
Pour créer une clé, consultez À propos des clés API. Vous pouvez limiter une clé à certaines adresses IP et lui donner une date d'expiration.
Méthodes HTTP
- GET lit des données. Il ne modifie jamais rien.
- POST crée une nouvelle ressource, par exemple un nouveau groupe. Le corps de la requête contient la nouvelle ressource en JSON.
- PUT met à jour une ressource existante.
- DELETE supprime une ressource par son ID.
Les corps des requêtes et des réponses sont en JSON (le XML est aussi pris en charge).
Paramètres
- Les paramètres de chemin font partie de l'URL et identifient une ressource, par exemple l'ID du groupe dans
/api/groups/{id}/members. Remplacez-les par des valeurs réelles de votre compte. - Les paramètres de requête (query string) filtrent les résultats et les répartissent en pages, par exemple
/api/groups?SearchTerm=vip&Page=1&Limit=50. - Les paramètres du corps forment l'objet JSON que vous envoyez avec les requêtes POST et PUT.
Les paramètres de chaque point de terminaison, et ceux qui sont obligatoires, figurent dans les guides de référence de l'API.
Pagination
Les points de terminaison qui renvoient des listes répartissent les résultats en pages. Utilisez Page pour choisir la page (à partir de 1) et Limit pour choisir le nombre d'éléments par page (jusqu'à 100, moins pour certains points de terminaison). Sans Limit, vous obtenez 20 éléments. Demandez la page suivante jusqu'à recevoir une réponse vide. Pour plus de détails, consultez Limites de l'API et pagination.