הגשת בקשות

בניית בקשות

הבקשות מורכבות משלושה מרכיבים:

  • גרסת API
  • נתיב משאבים
  • סוג פלט

כדי לבנות בקשה נכונה, תצטרך לעצב את ה-URI באופן הבא:

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

בקשה לדוגמה, להביא רשימה של חברים שרכשו חבילה.

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

כברירת מחדל, בקשות הן בקשות HTTP GET. עם זאת, שיטות רבות ידרשו ממך לשלוח נתוני POST. בדרך כלל, אנו נעקוב אחר הסטנדרט של כל בקשות הקריאה באמצעות GET, ובקשות כתיבה באמצעות POST.

בנוסף לפרמטרים הנדרשים עבור כל שיטה בודדת, תצטרך גם לשלוח את מפתח ה-API שלך.

אם אתה משתמש ב-API בצד השרת, תצטרך לשלוח secret_key עם ערך מפתח ה-API הסודי שלך.

גרסת API

עבור כל בקשה עליך לציין באיזו גרסה של ה-API ברצונך להשתמש. נכון לעכשיו, ברירת המחדל, והגרסה היחידה הזמינה, היא 1.0.

נתיב משאבים

נתיב המשאב זמין עבורך בתיעוד נוסף.

פורמטים של נתונים

YouRepo only supports one data format currently, JSON.

תגובות

התגובה לבקשתך תכיל מספר דברים מרכזיים:

  • קוד מצב HTTP
  • סטטוס API קוד
  • הודעת תגובה של API

ניקח בקשה לדוגמה:

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