page icon

REST API 仕様書 0.0.1

REST API仕様書(暫定案)
Rev. 0.0.1
⚠️
以下は暫定案です。
なお、すでにAPIのご準備がある場合は、ご準備いただいたものを使用可能です。

目次

1. 共通仕様

1.1. 全般

ホスト<パブリッシャー任意>
プロトコルHTTPS
文字コードUTF-8

1.2. リクエスト仕様

■リクエストヘッダー
キー内容
authorizationbearer [ACCESS_TOKEN]認証情報
content-typeapplication/jsonコンテンツタイプ
■リクエストパラメータ
キー内容
■リクエストボディー
キー内容

1.3. 正常レスポンス

■レスポンスヘッダー
キー
HTTPステータス200
content-typeapplication/json
■レスポンスボディ
キー内容
result_codePUBxxxx結果コード
messagexxxxxxxメッセージ

1.4. エラーレスポンス

■レスポンスヘッダー
キー
HTTPステータス400 以降
content-typeapplication/json
■レスポンスボディ
キー内容
result_codePUBxxxxエラーコード
messagexxxxxxxエラーメッセージ

2. API

2.1. アイテム購入可能チェック(GET/check)

購入ユーザーが指定のゲーム内アイテムの購入可能がどうか確認を行う

2.1.1. リクエスト

■リクエスト
エンドポイント/check
メソッドGET
■リクエストパラメータ
キー設定値内容
gameゲームIDパブリッシャーが指定するゲームタイトルのユニークID
userゲーム内ユーザーID購入ユーザーが指定したゲーム内のユーザーID
itemゲーム内アイテムIDパブリッシャーが指定するゲーム内課金アイテムのユニークID
■リクエストサンプル
GET /check?game=9nuKfGCi&user=XQagx3e6&item=8gvyzdur

2.1.2. レスポンス(正常時)

■レスポンスヘッダー
キー
HTTPステータス200
content-typeapplication/json
■想定レスポンスボディー
result_codemessage内容
PUB0000OKリクエストされた商品は購入可能である
PUB2003商品ID'${item}'は販売不可のため購入できません。リクエストされた商品はパブリッシャーの制限により購入できない
PUB2004商品ID'${item}'はユーザーが購入条件を満たさないため購入できません。リクエストされた商品は対象ユーザーが購入条件を満たさないため購入できない

2.1.3. レスポンス(リクエストエラー)

■レスポンスヘッダー
キー
HTTPステータス400
content-typeapplication/json
■想定レスポンスボディー
result_codemessage内容
PUB1000パラメータ'${param}'が指定されていません。必須パラメータが指定されていない
PUB1001パラメータ'${param}'の値が不正です。設定しているパラメータの値が正しくない

2.1.4. レスポンス(認証エラー)

■レスポンスヘッダー
キー
HTTPステータス401
content-typeapplication/json
■想定レスポンスボディー
result_codemessage内容

2.1.5. レスポンス(リソースエラー)

■レスポンスヘッダー
キー
HTTPステータス404
content-typeapplication/json
■想定レスポンスボディー
result_codemessage内容
PUB2000指定されたユーザーは無効です。該当するユーザーが存在しない。
PUB2001ゲームID'${game}'は無効です。該当するゲームが存在しない。
PUB2002商品ID'${item}'は無効です。該当する商品が存在しない。

2.2. アイテム購入実績登録(POST/register)

購入ユーザーの指定のゲーム内アイテムの購入実績を登録する

2.2.1. リクエスト

■リクエスト
エンドポイント/register
メソッドPOST
■リクエストパラメータ
キー設定値内容
gameゲームIDパブリッシャーが指定するゲームタイトルのユニークID
userゲーム内ユーザーID購入ユーザーが指定したゲーム内のユーザーID
itemゲーム内アイテムIDパブリッシャーが指定するゲーム内課金アイテムのユニークID
■リクエストサンプル
POST /register?game=9nuKfGCi&user=XQagx3e6&item=8gvyzdur

2.2.2. レスポンス(正常)

■レスポンスヘッダー
キー
HTTPステータス200
content-typeapplication/json
■想定レスポンスボディー
result_codemessage内容
PUB0000OK購入実績は正常に登録された。

2.2.3. レスポンス(リクエストエラー)

■レスポンスヘッダー
キー
HTTPステータス400
content-typeapplication/json
■想定レスポンスボディー
result_codemessage内容
PUB1000パラメータ'${param}'が指定されていません。必須パラメータが指定されていない
PUB1001パラメータ'${param}'の値が不正です。設定しているパラメータの値が正しくない

2.2.4. レスポンス(認証エラー)

■レスポンスヘッダー
キー
HTTPステータス401
content-typeapplication/json
■想定レスポンスボディー
result_codemessage内容

2.2.5. レスポンス(処理不能エラー)

■レスポンスヘッダー
キー
HTTPステータス422
content-typeapplication/json
■想定レスポンスボディー
result_codemessage内容
PUB2000指定されたユーザーは無効です。該当するユーザーが存在しない。
PUB2001ゲームID'${game}'は無効です。該当するゲームが存在しない。
PUB2002商品ID'${item}'は無効です。該当する商品が存在しない。
PUB2003商品ID'${item}'は販売不可のため購入できません。リクエストされた商品はパブリッシャーの制限により購入できない。
PUB2004商品ID'${item}'はユーザーが購入条件を満たさないため購入できません。リクエストされた商品は対象ユーザーが購入条件を満たさないため購入できない。