Suivez ces pratiques pour que votre intégration avec l'API ActiveTrail reste fiable et efficace.
Gérer les erreurs
Des problèmes de connexion et des erreurs peuvent survenir avec n'importe quelle API. Vérifiez toujours la réponse de chaque appel. Si un appel échoue, journalisez-le avec le plus de détails possible : ce que vous avez envoyé, la réponse d'erreur complète et les en-têtes. Vous trouverez ainsi la cause beaucoup plus vite si vous devez contacter le support ActiveTrail. Consultez Glossaire des erreurs de l'API.
Dans la mesure du possible, faites les appels API en arrière-plan, au lieu de faire attendre la réponse à vos utilisateurs. Exception : un formulaire d'inscription personnalisé, où les personnes veulent en général savoir tout de suite si leur inscription a fonctionné.
Faire moins d'appels, plus précis
- Ne demandez que les données dont vous avez besoin.
- N'interrogez pas l'API plus souvent que nécessaire. Par exemple, la plupart des ouvertures et des clics d'une campagne ont lieu dans les 24 heures qui suivent l'envoi : inutile de lire les statistiques de la campagne toutes les heures pendant des jours.
- Ne synchronisez que les données nouvelles ou modifiées, et mettez en cache les données qui changent rarement.
Mettre les valeurs en cache
Mettez en cache les valeurs que vous utilisez souvent mais qui changent rarement, comme les ID des groupes, des campagnes et des automations. Si votre intégration a une zone de réglages, laissez les utilisateurs y modifier ces valeurs.
Protéger vos clés API
- Utilisez TLS (HTTPS) pour chaque appel.
- Dans la mesure du possible, limitez les clés à certaines adresses IP et donnez-leur une date d'expiration.
- Donnez à chaque développeur ou système sa propre clé, pour pouvoir gérer et désactiver les clés séparément.
Consultez À propos des clés API.
Équilibrer le volume d'appels
Utilisez la pagination plutôt que de nombreux appels pour un seul élément. Par exemple, des centaines d'appels par seconde pour lire 200 contacts un par un peuvent passer pour un abus. Lisez-les plutôt par pages. Consultez Limites de l'API et pagination.