Construire les requêtes

Les requêtes sont faites de trois composants :

Version de l’API
Chemin de la ressource
Type de sortie

Pour construire une requête appropriée, vous aurez besoin de formater l'URI comme suit:

https://api.yourepo.com/{version}/{resource}.{output_type}

Une requête d'exemple, pour récupérer une liste de membres qui ont acheté un paquet.

https://api.yourepo.com/1.0/package/buyers.json?package=com.yourepo.source.package

Par défaut, les requêtes sont des requêtes HTTP GET. Cependant, de nombreuses méthodes vous obligeront à envoyer des données en POST. Typiquement, nous allons suivre la norme en utilisant pour toutes les requêtes de lecture la méthode GET, et celle d’écriture la méthode POST.

En plus des paramètres requis pour chaque méthode individuelle, vous aurez également besoin d'envoyer votre clé API.

Si vous utilisez l'API côté serveur, vous aurez besoin d'envoyer secret_key avec la clé secrète de votre application.

Version de l’API

Pour chaque requête, vous devez spécifier la version de l'API que vous souhaitez utiliser. Actuellement, la valeur par défaut, et la seule version disponible, est 1.0.

Chemin de la ressource

Le chemin de la ressource est mis à votre disposition dans d'autres documents.

Format des données

YouRepo supporte seulement un format actuellement, JSON.

Réponses

La réponse à votre requête contiendra plusieurs éléments clés :

Code d’état HTTP
Code d’état de l’API
Message de réponse de l’API

Prenons une requête en exemple :

GET https://api.yourepo.com/1.0/package/buyers?package=com.yourepo.source.package&secret_key=YOUR_SECRET_KEY

{
	"code": 0,
	"response": {
		"start": 0,
		"limit": 25,
		"total": "62",
		"page": 1,
		"buyers": [
			{
				"nickname": "member1",
				"status": "Completed",
				"profile_url": "https:\/\/www.yourepo.com\/forum\/profile\/member1"
			},
			{
				"nickname": "member2",
				"status": "Completed",
				"profile_url": "https:\/\/www.yourepo.com\/forum\/profile\/member2"
			},
			.....
		]
	}
}