Méthodes disponibles
...
Pour être informés de toutes les mises à jour concernant l’API v2 de SPREAD, inscrivez-vous ici : https://social-sb.com/z/newsletter-api-v1-v2
Info | ||||
---|---|---|---|---|
| ||||
|
GET Campaign
Cette méthode permet de récupérer les informations d'une campagne.
GET ⇒ social-sb.com/api/v2/campaigns/{id}
Cette méthode permet de récupérer les informations d'une campagne
Paramètres obligatoires :
- "id" : identifiant SPREAD de la campagne
Paramètres complémentaires :
Aucun
Réponse :
Si GET ok alors
Code Block | ||||
---|---|---|---|---|
| ||||
"campaign": [ { "id": "12345", "operationId": "54321", "name": "Instant gagnant hiver", "backofficeName": "Instant gagnant", "url": "instant-gagnant", "type": "instantwinner", "lang": "fr", "createdAt": "2018-01-08 08:22:58", "updatedAt": "2018-06-14 12:39:46", "dateStart": null } |
Sinon, affichage message d'erreur.
Exemple d'appel PHP :
Code Block | ||||
---|---|---|---|---|
| ||||
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/campaigns/12345");
curl_setopt($curl, CURLOPT_ |
...
USERPWD, |
...
"cle_publique:cle_privee"); |
...
// À remplacer par les clés d'API publique et privée dans votre back office, menu "Paramétrage > Tracker |
...
" en bas de page curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); $curl_return = curl_exec($curl); var_dump($curl_return); curl_close($curl); |
...
GET Campaigns
Cette méthode permet de récupérer toutes les campagnes d'un site_id.
GET ⇒ social-sb.com/api/v2/campaigns
Paramètres obligatoires :
Aucun
Paramètres complémentaires :
Aucun
Réponse :
Si GET ok alors
Code Block | ||||
---|---|---|---|---|
| ||||
"campaigns": [ { "id": "12345", "operationId": "54321", "name": "Instant gagnant hiver", "backofficeName": "Instant gagnant", "url": "instant-gagnant", "type": "instantwinner", "lang": "fr", "createdAt": "2018-01-08 08:22:58", "updatedAt": "2018-06-14 12:39:46", "dateStart": null }, { "id": "12346", "operationId": "5431", "name": "Concours photos", "backofficeName": "Concours photo numéro 2", "url": "concours-photos", "type": "contest", "lang": "fr", "createdAt": "2018-01-08 08:23:32", "updatedAt": "2018-06-14 12:39:41", "dateStart": null } ], "count": 2, "nextPageUrl": "http://social-sb.com/api/v2/campaigns?startAt=2" |
Sinon, affichage message d'erreur.
Exemple d'appel PHP :
Code Block | ||||
---|---|---|---|---|
| ||||
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/campaigns");
curl_setopt($curl, CURLOPT_ |
...
USERPWD, |
...
"cle_publique:cle_privee"); |
...
// À remplacer par les clés d'API publique et privée dans votre back office, menu "Paramétrage > Tracker |
...
" en bas de page curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); $curl_return = curl_exec($curl); var_dump($curl_return); curl_close($curl); |
Faire une recherche précise :
Il est possible d'affiner la liste retournée en passant des paramètres GET.
Les paramètres d'affinage possibles :
- "createdAfter" ⇒ seules les campagnes créées après la date passée en paramètre seront remontées
- "createBefore" ⇒ seules les campagnes créées avant la date passée en paramètre seront remontées
- "modifiedAfter" ⇒ seules les campagnes modifiées après la date passée en paramètre seront remontées
- "modifiedBefore" ⇒ seules les campagnes modifiées avant la date passée en paramètre seront retournées
- "operartionId" ⇒ seules les campagnes appartenant à l'opération passée en paramètres seront retournées
- "url" ⇒ seule la campagne dont l'url est égale à celle passée en paramètre sera retournée
Les paramètres sur la pagination :
- "startAt" ⇒ permet de commencer la liste des campagnes à partir de l'occurence passée en paramètre
- "maxResult" ⇒ permet de limiter le nombre de campagnes remontées par pages (max 5000)