Yêu cầu

Xây dựng yêu cầu

Yêu cầu được thực hiện từ ba thành phần:

  • Phiên bản API
  • Đường dẫn tài nguyên
  • Loại đầu ra

Để tạo một yêu cầu thích hợp, bạn sẽ cần định dạng URI như sau:

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

Một yêu cầu ví dụ, để tìm nạp danh sách các thành viên đã mua một gói.

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

Theo mặc định, các yêu cầu là các yêu cầu HTTP GET. Tuy nhiên, nhiều phương pháp sẽ yêu cầu bạn gửi dữ liệu POST. Thông thường, chúng tôi sẽ tuân theo tiêu chuẩn của tất cả các yêu cầu đọc sử dụng GET và viết các yêu cầu sử dụng POST.

Ngoài các tham số bắt buộc cho từng phương thức riêng lẻ, bạn cũng sẽ cần gửi khóa API của mình.

Nếu bạn đang sử dụng API phía máy chủ, bạn sẽ cần gửi secret_key cùng với giá trị khóa API bí mật của mình.

Phiên bản API

Đối với mỗi yêu cầu, bạn nên chỉ định phiên bản API mà bạn muốn sử dụng. Hiện tại, phiên bản mặc định và duy nhất có sẵn là 1.0.

Đường dẫn tài nguyên

Đường dẫn tài nguyên có sẵn cho bạn trong tài liệu bổ sung.

Định dạng dữ liệu

YouRepo only supports one data format currently, JSON.

Phản hồi

Phản hồi yêu cầu của bạn sẽ bao gồm một số điều chính:

  • Mã trạng thái HTTP
  • Trạng thái API
  • Thông báo phản hồi API

Hãy lấy một yêu cầu ví dụ:

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