Introduction
Cette API permet d’interroger Splio en iframe et obtenir les Heatmap depuis les statistiques de campagnes dans Scenario par simple appel https. La Heatmap permet de voir quels sont les liens les plus cliqués dans le design email d'une campagne.
Accès
L’API est accessible via un simple appel HTTPS.
https://<univers>.sp-ring.com/portable-heatmap.pl
Il faut remplacer <univers> par le nom de votre univers.
Authentification
Pour accorder l’accès via l’API, l’univers Splio vous demandera un token à calculer et dont la composition est expliquée ci-dessous.
Le mot de passe est dédié à l’API et à l’univers. Il vous faut la demander à Splio. Le token est un SHA1 (héxadécimal minuscule) de trois chaines concaténées :
- Le nonce cryptographique (par exemple 1464545737)
- Par exemple, un timestamp : $nonce = time();
- L'id d'envoi (par exemple 6ikdLAFji)
- Le mot de passe API (42020b2de2599a6978aXXXXXXXXXXXXXXXXXXXXX) On doit donc calculer le SHA1 de
<nonce><id d’envoi><mot de passe communiqué par Splio>
Exemple : 14645457376ikdLAFji42020b2de2599a6978aXXXXXXXXXXXXXXXXXXXXX
Qui donne le token à utiliser : 936e3633f5d2aec2592YYYYYYYYYYYYYYYYYYYY
Paramètres
Voici les paramètres de l’appel API. Tous sont obligatoires.
|
Univers |
Nom de l’univers Splio |
|
sendout |
ID de l’envoi, que l’on retrouve dans l’URL des statistiques de la campagne |
|
nonce |
nonce cryptographique |
|
token |
Token SHA1 calculé |
Example d’appel
L’appel doit se faire ainsi :
https://{ univers }.sp-ring.com/portable-heatmap.pl?sendout={ id envoi }&nonce={ nonce }&token={ token SHA1 calculé }
Avec les éléments suivants :
- Univers : univers_id
- Id de l’envoi : 6ikdLAFji
- Nonce : 1464545737
- La clé : 42020b2de2599a6978aXXXXXXXXXXXXXXXXXXXXX
Au préalable je calcule le token :
SHA1 de: 14645457376ikdLAFji42020b2de2599a6978aXXXXXXXXXXXXXXXXXXXXX
On obtient : 936e3633f5d2aec2592YYYYYYYYYYYYYYYYYYYY
L’appel devra être :
https://univers_id.sp-ring.com/portable- heatmap.pl?sendout=6ikdLAFji&nonce=1464545737&token=936e3633f5d2aec2592YYYYYYYYYYYYYYYYYY
Les réponses possibles de l’API
- La réponse positive de l’appel se matérialise par l’affichage web de la heatmap
- La réponse négative de l’appel se matérialise par l’affichage web d’un message « error=token »
Example
- Réponse positive
- Réponse négative
