Skip to content
Cybernetik edited this page Oct 4, 2018 · 16 revisions

API Http principe général

Informations sur l'authentification

L'authentification sera effectuée par une clef dynamique transmise dans header HTTP via cURL. la clef devra être composée d'un token unique et d'une partie qui évolue chaque jour.

Exemple possible en php:

<?php
$token = sha1( "{clef fournis par gamify}" . md5( date('Y-m-d') ) );
?>

Informations sur l'intégrité des données

L'ensemble des données devront être fournies au format JSON validé par json lint. Les champs "vide" devront être tout de même transmis avec la valeur null.

Informations sur les messages d'erreur et de succès

Les messages d'erreurs seront transmis au format JSON, transmis de la manière suivante:

Tout est ok:

{
	"succes": "Les donnés {API Name} ont bien été importées dans gamify",
	"error_code": "0"
}

Erreur inconnue:

{
	"error": "Erreur inconue",
	"error_code": "1"
}

Erreur authentification:

{
	"error": "La clef d'authentification est invalide",
	"error_code": "2"
}

Erreur id game:

{
	"error": "Le jeu {id_api_game} n'existe pas",
	"error_code": "3"
}

Erreur formatage json:

{
	"error": "Les données sont corrompues",
	"error_code": "4"
}

Erreur données dupliquées:

{
	"error": "Les données ont déjà été transmises à gamify",
	"error_code": "5",
	"error_detail": "liste des ids dupliquées séparées par des ';'"
}

Erreur données mal formatées:

{
	"error": "Les données transmises sont invalides",
	"error_code": "6",
	"error_detail": "liste des ids invalides séparées par des ';'"
}

Erreur méthode pas encore implémentée:

{
	"error": "Méthode pas encore implémentée.",
	"error_code": "7",
}

Erreur liée à l'origne:

{
	"error": "Origne inconue ou invalide.",
	"error_code": "8",
}

Erreur éléments trop nombreux:

{
	"error": "Trop d'éléments pushés d'un coup. X max.",
	"error_code": "9",
}