1.概要

開催中のゲームマラソンの実績の取得、ミッションを達成した際に履歴を登録します。
※ゲスト会員に当APIは利用できません。

2.リクエスト

2.1 エンドポイント

http://gpf-api.[対象ドメイン]/api/game_marathon

2.2 HTTPメソッド

HTTPメソッド	機能
GET	API実行元と同じゲームの 開催中/検証中のゲームマラソンの実績を取得する ※開催中、検証中の両方がある場合は開催中を取得
PUT	–
POST	ゲームマラソン履歴を登録する
DELETE	–

【GET時仕様】

2.3 クエリパラメータ

uuid（必須）

フォーマット	内容	備考
半角英数	ユーザーを特定する識別キー

game_code（必須）

フォーマット	内容	備考
半角英数記号	ゲームを特定する為のコード	GAME_CODEはゲーム追加申請時にお知らせする値になります。

hash（必須）

フォーマット	内容	備考
半角英数	データ改竄防止のためのハッシュキー	SHA1(uuid + game_code  + api_key(ゲーム追加申請時にお知らせする値))

3.レスポンス

パラメータ	内容	フォーマット
status_code	処理結果のステータスコード	数字
status_msg	ステータスメッセージ	文字列
point	現在のポイント（走破距離（メートル単位））	数字
pass	マラソンパスの購入（購入済はtrue、未購入はfalse）	文字列

X.サンプル

X.1 成功時のレスポンス

{ "status_code":"200", "status_msg":"成功", "point":1200, "pass":"false" } 

X.2 エラー時のレスポンス例

{ "status_code":400, "status_msg":"パラメータ不足エラー" } 

 

【POST時仕様】

2.3 クエリパラメータ

uuid（必須）

フォーマット	内容	備考
半角英数	ユーザーを特定する識別キー

game_code（必須）

フォーマット	内容	備考
半角英数記号	ゲームを特定する為のコード	GAME_CODEはゲーム追加申請時にお知らせする値になります。

code（必須）

フォーマット	内容	備考
半角英数	対象のミッションコード、 及び結果コードをハイフンで繋いだもの 例： バトル(勝利) battle-win バトル(敗北) battle-lose	ゲームマラソンミッション申請完了時にお知らせするコード

hash（必須）

フォーマット	内容	備考
半角英数	データ改竄防止のためのハッシュキー	SHA1(uuid + game_code + code + api_key(ゲーム追加申請時にお知らせする値))

3.レスポンス

パラメータ	内容	フォーマット
status_code	処理結果のステータスコード	数字
status_msg	ステータスメッセージ	文字列

X.サンプル

X.1 付与完了後のレスポンス

{ "status_code":"200", "status_msg":"成功" } 

X.2 エラー時のレスポンス例

{ "status_code":400, "status_msg":"パラメータ不足エラー" }