Comment utiliser l’API de call-tracking ?
L'API Magnétis vous permet d'intégrer le call-tracking dans vos propres outils.
Structure et documentation
La documentation comprenant la structure et l'utilisation de l'API Magnétis est disponible à l'adresse : https://docs.magnetis.io/
Vous y trouverez les routes nécessaires à la gestion :
De votre architecture de call-tracking, à savoir les entités, réseaux et comptes dans lesquels sont intégrés vos numéros trackés
La gestion de vos numéros trackés et pools de numéros trackés
La gestion des destinataires de vos appels reçus
La collecte des appels reçus, des parcours visiteurs et des conversions
La gestion de l'email tracking
Les leads générés par vos appels entrants et par l'email-tracking
Le paramétrage de vos rapports statistiques et de vos alertes sur appels manqués par email et par SMS
La gestion de vos éléments de contenus, tels que les landing pages, les SMS et les fichiers audios
Pour chaque route et chaque méthode, vous trouverez dans la documentation :
Un exemple de requête
Un exemple de réponse avec des données de démonstration
Les paramètres d'URL
Les champs de réponses et leurs valeurs
Clé API
Vous pouvez créer des clés API pour l'ensemble de votre entreprise, agence ou réseaux de points de vente dans la partie Organisation de l'interface Magnétis, ou pour des réseaux ou comptes spécifiques.
Pour cela, une fois connecté au compte/réseau souhaité, rendez-vous dans API & connecteurs > API.
Une clé Sandbox est par défaut présente dans l'interface. Elle vous permet de tester l'API avec des données d'exemple.
Pour créer une nouvelle clé API, cliquez sur "Ajouter une clé" puis saisissez un nom explicite, une date d'expiration si cette clé est utilisée pour du développement ou pour une utilisation temporaire de la connexion API et un filtre IP pour limiter les machines autorisées à interroger l'API.
Statistiques et limites d'utilisation de l'API
Vous pouvez suivre dans l'interface les appels aux différentes routes et les résultats obtenus sur les 30 derniers jours.
Documentation express :
Chaque clé API dispose d'une limite de 5000 appels jours. Vous pouvez modifier cette limite en vous rapprochant de votre gestionnaire de compte.
Utilisation de la pagination
L'API fonctionne avec un système de pagination à l'API afin d'optimiser ses performances. Le nombre de calls maximum par page est de 250.
Par exemple, pour voir la deuxième page, il vous suffit d'utiliser le paramètre d'URL "page=2".
Afin de parcourir l'ensemble des pages dans un script, plusieurs solutions :
Utiliser l'objet "links" présent dans le retour API pour appeler le lien "next" jusqu'à ce que celui-ci soit null
Utiliser l'objet "meta" présent dans le retour API pour boucler autant de fois que nécessaire (jusqu'à ce que la variable "current_page" soit égale à la variable "last_page" par exemple, ou jusqu'à ce que la variable "to" soit égale à la variable "total")