Introduction
This API allows you to query Splio in iframe and obtain Heatmaps from campaign statistics in Scenario by simply calling https. The Heatmap allows you to see which are the most clicked links in the email design of a campaign.
Access
https://<univers>.sp-ring.com/portable-heatmap.pl
Authentication
To grant access via the API, the Splio universe will ask you for a token to calculate, the composition of which is explained below. The password is dedicated to the API and the universe. You have to ask Splio for it. The token is a SHA1 (lowercase hexadecimal) of three concatenated string
- For example, a timestamp : $nonce = time();
- The sending ID (for example 6ikdLAFji)
- The API password (42020b2de2599a6978aXXXXXXXXXXXXXXXXXXXXX) On doit donc calculer le SHA1 de
<nonce><sending ID><password sent by Splio>
Example: 14645457376ikdLAFji42020b2de2599a6978aXXXXXXXXXXXXXXXXXXXXX
Which gives the token to use: 936e3633f5d2aec2592YYYYYYYYYYYYYYYYYYYY
Parameters
|
Universe |
name of the universe |
|
sendout |
Sending ID, which you can find in the URL of the campaign's statistics |
|
nonce |
cryptographic nonce |
|
token |
Token SHA1 calculated |
Call example
You should do the call this way:
https://{ univers }.sp-ring.com/portable-heatmap.pl?sendout={ id envoi }&nonce={ nonce }&token={ token SHA1 calculé }
With the following items:
- Universe: univers_id
- Sending ID: 6ikdLAFji
- Nonce: 1464545737
- The key: 42020b2de2599a6978aXXXXXXXXXXXXXXXXXXXXX
Before you calculate the token:
SHA1 of: 14645457376ikdLAFji42020b2de2599a6978aXXXXXXXXXXXXXXXXXXXXX
You get: 936e3633f5d2aec2592YYYYYYYYYYYYYYYYYYYY
The call should be:
https://universe_id.sp-ring.com/portable- heatmap.pl?sendout=6ikdLAFji&nonce=1464545737&token=936e3633f5d2aec2592YYYYYYYYYYYYYYYYYY
The API possible answers
Example
- Positive response
- Negative response
