L’API est une interface d’application qui permet de connecter un logiciel à un autre logiciel pour échanger des données et des fonctionnalités.
Objectifs :
Créer une interconnexion afin de récupérer de la data.
Permettre d’interroger l’API en temps réel et lorsque vous en avez besoin.
Les données qui peuvent être récupérées :
L’API est catégorisée en section
Client : Données liées aux clients
Données sur l’abonnement (Date de création, Ville, ID de l’abonnement)
Contest : Données liées aux opérations
ID de l’opération
Titre de l’opération
Hauteur & Largeur des pages Desktop/Mobile
Date de publication de l’opération
Date de lancement et de fin de l’opération
Information sur le tracking mis en place
Contest Entry : Données liées aux participants
ID du participant
Email du participant
Prénom/Nom du participant
Genre
Date de naissance
Date de validation du formulaire
Campaign : Données liées aux campagnes email
ID de la campagne email
Titre
ID de l’opération associée
Statistiques (Taux d’ouverture, Taux de rebond, Taux de clic, Nombre de mails envoyés, Nombre de mails ouverts)
Contest Participation : Données liées aux participations
ID de la participation
Données liées au Formulaire (Prénom, Nom, Email, Adresse, Ville, Code Postal, Optin …)
Adresse IP
Type d'appareil utilisé (mobile, desktop)
Navigateur
Données sur la dotation (Titre, Description & Code unique)
Récupérer des données selon le type de mécanique :
Jeu concours-photo
Lien de la photo importé
Description de la photo
Titre de la photo
Vote “valeur = null ou 1” (lien de la photo votée)
Jeu avec obligation d’achat
(Code d’accès) “access_codes”
(Preuve d’achat) lien de la preuve d’achat “purchase_proofs”
(Preuve d’achat avec sogec) : ID de la participation lié à Sogec, statut de validation et commentaire de conformité, date de retour sogec lors de la récupération de l’information ..
Quiz
Réponses aux questions
La donnée sur la bonne réponse “is_good” = 1
Le score
Temps passé “time_spend”
Paramétrer l’API V2
Etape 1 : Se connecter à l’API
Se connecter à l’interface Kimple
Accéder à l’onglet “Paramètres du compte ” ⇒ “Intégration”
Récupérer votre API Key et cliquer sur le bouton "Générer votre API secret” afin de pouvoir utiliser l'API. (l’Api Key & Secret sont uniques et nominatifs. Si les informations sont perdues, il faudra générer de nouveaux accès )
Etape 2 : Tester l’API
A partir de ce lien https://apiv2.kimpleapp.com/api/doc_client, vous accéderez à l’interface pour tester la récupération de données relatives au compte client, aux participants, aux participations, aux campagnes email..
- Cliquez sur le bouton “Authorize”
- Inscrire son API Key et API Secret
- Accès aux données liées au compte client, participants et participations
Lors de vos tests, vous pouvez faire des recherches, filtrer, trier ... :
Page index : permet de naviguer entre les pages
Limites de résultats : permet de limiter le nombre de résultats par page ex : '/list?limit=10'
L'ordre croissant-décroissant : permet de trier les résultats dans l'ordre croissant ou décroissant ex : '/list?order=firstname%20asc'
Moteur de recherche : permet de filtrer les résultats selon une donnée ex : '/list?search=email~%3D%27cassiop.com%27'
Possibilité de combiner les différentes options :
/list?limit=10&order=firstname%20asc&search=email~%3D%27cassiop.com%27
contest-hash-id : permet de récupérer les données d'une opération
Exemple : appeler l'endpoint https://apiv2.kimpleapp.com/v2/contests/list afin de retrouver le contest-hash-id d'une opération.
Résultat :
{ "id": 0, "hash_id": "78HY9n", "version": 1, "state": 0, "activity_area": 6, "year_highlight": 0, "analytics_id": "", "analytics_script": "", "api_callback_uri": null, "confirm_opt_in_desktop_image_id": null, "confirm_opt_in_mobile_image_id": null, "confirm_opt_in_text": null, "background_color": "", "client_title": "", "custom_css": "", "custom_js": "", "title": "", "description": "wdxc", "height_desktop": 900, "height_facebook": 1000, "height_mobile": 1200, "hide_from_inspiration": false, "template": 33, "width_desktop": 1000, "width_facebook": 810, "width_mobile": 320, "is_anonymized": 0, "is_maintenance_mode": 0, "finish_at": "2019-08-15 14:47:00", "last_updated_at": "2019-08-15 14:56:02", "no_end_at": 0, "published_at": "2019-07-16 14:55:40", "start_at": "2019-07-16 14:47:00", "last_activities_update": null, "client_id": 0, "client_hash_id": "", "client_name": "0", "contest_stats_id": 12939, "contest_stats_hash_id": "eeOvCDZ", "content_link": null, "locale": "fr", "created_at": "2019-07-16 14:48:06", "updated_at": "2019-08-22 14:47:01" },contest-entry-hash-id : permet de récupérer les données d'un participant
Exemple : appeler l'endpoint https://apiv2.kimpleapp.com/v2/contest_entries/list?contest_hash_id=78HY9n&include_participations=false en ajoutant l'identifiant de l'opération
Résultat :
data": [ { "id": 0, "contest_entry_hash_id": "QKr1mkPcJb", "email": "kimple@kimpleapp.com", "firstname": "", "lastname": "", "gender": 0, "birthday": null, "address": "", "zipcode": "", "city": "", "country": "", "score": "0", "contest_hash_id": "YP67sgn", "last_play_at": null, "last_attempt_at": null, "last_submit_form_at": "2019-07-16 16:56:09", "on_facebook": false, "facebook_id": 0, "instagram_id": 0, "on_web": true, "on_mobile": false, "is_suspect": false, "is_cheater": false, "total_invite": 0, "total_share": 0, "total_play": 0, "total_attempt": 0, "total_facebook_like": 0, "total_google_plus_share": 0, "total_mail_received": 0, "total_mail_sent": 0, "total_pinterest_follow": 0, "total_submit_form": 1, "total_twitter_follow": 0, "total_twitter_retweet": 0, "total_twitter_share": 0, "total_youtube_follow": 0, "last_ip": "90.120.30.193", "phone": "", "created_at": "2019-07-16 16:56:08", "updated_at": "2019-08-05 13:37:39" } ] }