Verzoeken doen

Verzoeken maken

Aanvragen bestaan ​​uit drie componenten:

• API-versie
• Bronpad
• Uitgangstype

Om een ​​juist verzoek op te stellen, moet u de URI als volgt formatteren:

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

Een voorbeeldverzoek, om een ​​lijst op te halen van leden die een pakket hebben gekocht.

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

Standaard zijn verzoeken HTTP GET-verzoeken. Voor veel methoden moet u echter POST-gegevens verzenden. Doorgaans volgen we de standaard van alle leesverzoeken met GET en voor schrijfverzoeken met POST.

Naast de vereiste parameters voor elke afzonderlijke methode, moet u ook uw API-sleutel verzenden.

Als u de server-side API gebruikt, moet u secret_key verzenden met uw geheime API-sleutelwaarde.

API-versie

Voor elk verzoek dient u aan te geven welke versie van de API u wilt gebruiken. Momenteel is de standaard en de enige beschikbare versie 1.0.

Bronpad

Het bronpad wordt u ter beschikking gesteld in verdere documentatie.

Gegevensformaten

YouRepo only supports one data format currently, JSON.

Reacties

Het antwoord op uw verzoek zal een aantal belangrijke dingen bevatten:

• HTTP-statuscode
• API-status code
• API-antwoordbericht

Laten we een voorbeeldverzoek nemen:

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"
			},
			.....
		]
	}
}