تقديم الطلبات

بناء الطلبات

تتكون الطلبات من ثلاثة مكونات:

• إصدار 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 الخاص بك.

إذا كنت تستخدم واجهة برمجة التطبيقات من جانب الخادم ، فستحتاج إلى إرسال secret_key بقيمة مفتاح واجهة برمجة التطبيقات السرية.

إصدار API

لكل طلب ، يجب عليك تحديد إصدار API الذي تريد استخدامه. حاليًا ، الإصدار الافتراضي والوحيد المتاح هو 1.0.

مسار الموارد

مسار الموارد متاح لك في مزيد من الوثائق.

تنسيقات البيانات

YouRepo only supports one data format currently, JSON.

استجابات

ستتضمن استجابة طلبك عدة أشياء رئيسية:

• رمز حالة HTTP
• حالة API code
• رسالة استجابة 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"
			},
			.....
		]
	}
}