Skip to content

API Played

Cybernetik edited this page Oct 17, 2018 · 13 revisions

POST:

Permet de soumettre la liste des participations d'un jeu. Cette API doit être appelée le plus régulièrement possible en cours d'opération (1 fois par minutes par exemple). L'API sera consultable via l'url suivante :

https://{URL Api Gamify}/played/{id_api_game}/

Données attendues au format json:

{
	"0":{
		"key": "identifiant unique de la donnée",
		"origine": "origine de la donnée",
		"audio": "url fichier audio",
		"participation_date": "date time de la participation au format: (0000-00-00 00:00:00)",
		"gift": "id du lot gagné (null si perdant)",
		"phone": "n° téléphone au format international",
		"phone_bis": "n° téléphone au format international bis",
		"email": "emai@dmain.ext",
		"last_name": "nom du participant",
		"first_name": "prénom du participant",
		"address": "addresse du participant",
		"address_bis": "addresse du participant",
		"city": "ville du participant",
		"country": "pays du participant",
		"no_card": "12345678",
		"number_sms": "nombre de sms si participation sms",
		"calling_duration": "durée de l'appel en millisecondes si participation audio",
        	"generic_data": "champ permettant l'ajout d'informations spécifiques à des jeux",
        	"generic_data_bis": "champ permettant l'ajout d'informations spécifiques à des jeux",
		"optin": 1,
		"birth_date": "2000-03-27 date de naissance au format YYYY-MM-DD",
		"status": "statut de la participation int"
	},
	"1":{
		"key": "identifiant unique de la donnée",
		"origine": "origine de la donnée",
		"audio": "url fichier audio",
		"participation_date": "date time de la participation au format: (0000-00-00 00:00:00)",
		"gift": "id du lot gagné (null si perdant)",
		"phone": "n° téléphone au format international",
		"phone_bis": "n° téléphone au format international bis",
		"email": "emai@dmain.ext",
		"last_name": "nom du participant",
		"first_name": "prénom du participant",
		"address": "addresse du participant",
		"address_bis": "addresse du participant",
		"city": "ville du participant",
		"country": "pays du participant",
		"no_card": "12345678",
		"number_sms": "nombre de sms si participation sms",
		"calling_duration": "durée de l'appel en seconde si participation audio",
        	"generic_data": "champ permettant l'ajout d'informations spécifiques à des jeux",
        	"generic_data_bis": "champ permettant l'ajout d'informations spécifiques à des jeux",
		"optin": 0,
		"birth_date": "2000-03-27 date de naissance au format YYYY-MM-DD",
		"status": "statut de la participation int"
	},
	"2":{
		"key": "identifiant unique de la donnée",
		"origine": "origine de la donnée",
		"audio": "url fichier audio",
		"participation_date": "date time de la participation au format: (0000-00-00 00:00:00)",
		"gift": "id du lot gagné (null si perdant)",
		"phone": "n° téléphone au format international",
		"phone_bis": "n° téléphone au format international bis",
		"email": "emai@dmain.ext",
		"last_name": "nom du participant",
		"first_name": "prénom du participant",
		"address": "addresse du participant",
		"address_bis": "addresse du participant",
		"city": "ville du participant",
		"country": "pays du participant",
		"no_card": "12345678",
		"number_sms": "nombre de sms si participation sms",
		"calling_duration": "durée de l'appel en seconde si participation audio",
        	"generic_data": "champ permettant l'ajout d'informations spécifiques à des jeux",
        	"generic_data_bis": "champ permettant l'ajout d'informations spécifiques à des jeux",
		"optin": 0,
		"birth_date": "2000-03-27 date de naissance au format YYYY-MM-DD",
		"status": "statut de la participation int"
	},
	[ ... ]
}

Lots multiples

Si la participation est gagnante avec plusieurs lots, il faudra envoyer dans le champ gift les données sous le format JSON suivant : "gift": [ id1, id2, ..., idx ] au lieu de l'habituel "gift": "id".

Format téléphone

  • 33[9 chiffres]
  • 33[4 chiffres]
  • #[X alphanumériques] pour les numéros SMS anonymisés.
Clone this wiki locally