ヤマダスイッチAPI

1.概要

指定したIDのヤマダスイッチが表示可能であるかどうかを確認します。

※ヤマダスイッチは毎日00:00にスイッチ表示時刻に表示可能とするスイッチの選定を行います。
この為、同一時間帯でも利用可能な日と利用不可の日がある場合がございます。

また、ヤマダスイッチの仕様上、ハズレを含め対象日にヤマダスイッチを押したユーザーからのリクエストについては、無条件に表示不可で返すようになります。

表示可能な場合と不可の場合でstatus_codeが異なりますので、そちらでご判断するようにしてください。

2.リクエスト

2.1 エンドポイント
http://gpf-api.[対象ドメイン]/api/yamada_switch

2.2 HTTPメソッド

HTTPメソッド 機能
GET 指定したIDのヤマダスイッチが表示可能か確認する
PUT –
POST –
DELETE –

2.3 クエリパラメータ
uuid（必須）

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

game_code（必須）

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

switch_id（必須）

フォーマット 内容 備考
半角英数 対象のスイッチID 別途お知らせするスイッチID

hash（必須）

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

3.レスポンス

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

X.サンプル

X.1 表示可能な場合

表示可能で返ってきた場合、下記URLに遷移するリンクを表示してください
http://gpf.[対象ドメイン]/yamada_switch/?switch_id=[対象のスイッチID]&return_url=[プラットフォームからの戻り先(未指定時はゲームのトップ画面になります)]

{ "status_code":"200", "status_msg":"Success" }

X.2 表示不可な場合

{ "status_code":"404", "status_msg":"対象データ存在チェックエラー" }