Clickncom

Appearance

Sur cette page

Commencer à intégrer ​

Clickncom est une plateforme SaaS de création de jeux concours. Clickncom a une api publique qui permet de récupérer des données. Cette api est celle qui est utilisée par notre plateforme en ligne. Si vous le souhaitez, vous pouvez regarder les appels effectués depuis notre site (une fois connecté sur votre compte) afin de récupérer ces données depuis un autre service.

Avertissement

Cette Api n'a pas été conçue pour être utilisée par des services tiers. Elle a été pensée pour interagir avec le front de notre plateforme. Cependant, certaines de ses fonctionnalités peuvent se révéler utile à des services tiers.

Clickncom ne garanti pas la rétrocompatibilité de cette api. Certaines routes sont amenées à évoluer. Si vous utilisez notre api, nous vous recommandons de prendre contact avec nous pour nous expliquer votre usage afin que nous vous informions lors de changements vous concernant.

Interagir avec l'api ​

Mise à part les données accessibles publiquement sur la plateforme (jeux, thèmes), les données créées par les utilisateurs nécessitent des droits pour être accédées.

Clickncom ne propose pas de clés d'api pour l'instant, aussi, pour interagir avec l'api, il est nécessaire d'utiliser le service d'authentification. L'appel à ce service par un service externe nécessite de passer le mot de passe de l'utilisateur au service.

Stockage des données sensibles

Attention à stocker de façon sécurisée ce mot de passe et de ne pas le commiter dans un repo.

Exemple de connection :

http
POST https://api.clickncom.com/auth/local

{
  "identifier": "ADRESSE EMAIL DE L'UTILISATEUR",
  "password": "MOT DE PASSE"
}

En réponse le service fournit en réponse un token jwt qui devra être utilisé à chaque requête à l'api.

Ce token a une durée de vie aussi il est recommandé de le renouveler régulièrement.

Données personnelles

Attention, avec ce token, il est possible de récupérer des données personnelles de participant des jeux concours publiés avec ce compte.

Usage ​

L'utilisation de l'api est possible pour créer des outils permettant d'intégrer clickncom dans une plateforme tierce par exemple.

Avertissement

Une mauvaise utilisation de l'api (trop d'appels, appels de type polling) pourront être sanctionnés par le blocage du compte de l'utilisateur à l'origine des appels (l'utilisateur dont le compte est utilisé pour se connecter)

Liste des jeux concours de l'utilisateur ​

http
GET https://api.clickncom.com/campaigns?&_start=0&_limit=20&_sort=created_at%3ADESC
Authorization: Bearer TOKEN_JWT

En réponse, un tableau contenant la liste des 20 derniers jeux concours de l'utilisateur triés par ordre de création décroissant

Le paramétrage de chaque jeu est dans l'attribut params de chaque objet retourné. Cet objet contient une grande partie dess paramètres définis via l'éditeur de jeu de Clickncom

Liste des participations d'un jeu concours ​

http
GET https://api.clickncom.com/participations?_start=0&_limit=50&campaign=ID&iamreal=true&date_play_null=false&_sort=group_last_play%3ADESC
Authorization: Bearer TOKEN_JWT

Cette requête récupère les 50 dernièrs participants du jeu cooncours dont l'identifiant est ID. Pour chaque participant retourné, la liste de ses participations est retournée également (si le rejeu est actif, plusieurs participations sont possibles pour un même participant)

Le paramètre iamreal=true permet de ne récupérer que de "vraies" participations, les robots sont exclus

Le paramètre date_play_null=false permet de ne récupérer que de les participations dont le participant a joué