リクエストの作成

  1. 家
  2. API
  3. ドキュメンテーション
  4. リクエストの作成

リクエストの構築

リクエストは、次の 3 つのコンポーネントで構成されます:

  • 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 を使用している場合は、シークレット 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"
			},
			.....
		]
	}
}