The API is an application interface that allows software to be connected to other software to exchange data and functionality.
Objectives :
Create an interconnection to collect data.
To allow the API to be queried in real time and when needed.
Data that can be collected :
The API is categorised into sections
Client : Client related data
Subscription data (creation date, city, subscription ID)
Contest: Operation Data
Operation ID
Operation Title
Desktop/Mobile Page Height & Width
Operation publication date
Date of launch and end of the operation
Tracking information
Contest Entry : Participant data
Contestant ID
Contestant's Email
Contestant's First/Last Name
Gender
Contestant's date of birth
Date of validation of the form
Campaign: Data related to email campaigns
Email campaign ID
Title
ID of the associated operation
Statistics (Open rate, Bounce rate, Click rate, Number of emails sent, Number of emails opened)
Contest Participation : Participation data
ID of the participation
Data related to the Form (First name, Last name, Email, Address, City, Postal code, Optin ...)
IP address
Type of device used (mobile, desktop)
Browser
Gift data (Title, Description & Unique code)
Collect data according to the type of games :
Photo contest game
Imported photo link
Description of the photo
Title of the photo
Vote "value = null or 1" (link of the voted photo)
Game with purchase obligation
(Access code) "access_codes"
(Proof of purchase) proof of purchase link "purchase_proofs"
(Proof of purchase with sogec): ID of the participation linked to sogec, validation status and compliance comment, sogec return date when getting the information..
Quiz
Answers to the questions
The data on the correct answer "is_good" = 1
The score
Time spent "time_spend"
Setting up the API V2
Step 1: Connect to the API
Log in to the Kimple interface
Go to "Account settings" ⇒ "Integration" tab
Retrieve your API Key and click on the "Generate your secret API" button to use the API. (Api Key & Secret are unique and nominative. If the information is lost, it will be necessary to generate new accesses)
Step 2: Test the API
From this link https://apiv2.kimpleapp.com/api/doc_client, you will access the interface for testing the retrieval of data relating to customer accounts, participants, entries, email campaigns...
- Click on the "Authorize" button
- Register your API Key and API Secret
- Access to customer account, participant and entry data
During your tests, you can search, filter, sort... :
Page index : allows you to navigate between pages
Results limits : allows you to limit the number of results per page, e.g. '/list?limit=10'.
Ascending-decreasing order : allows you to sort results in ascending or descending order ex: '/list?order=firstname%20asc'
Search engine : allows you to filter results according to a datum ex: '/list?search=email~%3D%27cassiop.com%27'
Different options can be combined :
/list?limit=10&order=firstname%20asc&search=email~%3D%27cassiop.com%27
contest-hash-id : retrieves data from an operation
Example : call the endpoint https://apiv2.kimpleapp.com/v2/contests/list to retrieve the contest-hash-id of an operation.
Result :
{ "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: retrieves data from a participant
Example : call the endpoint https://apiv2.kimpleapp.com/v2/contest_entries/list?contest_hash_id=78HY9n&include_participations=false by adding the operation identifier
Result :
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" } ] }