Skip to content
キャンペーンAPIのマニュアルです。
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
README.md

README.md

虎の穴キャンペーンサイトAPIマニュアル

本マニュアルについて

本マニュアルでは、虎の穴キャンペーンサイトが提供するAPI(キャンペーンAPI)の仕様をご確認いただけます。

機能一覧

キャンペーンAPIには以下のような機能があります。

  1. 現在応募可能なキャンペーン一覧を取得する
  2. 応募期間を指定してキャンペーン一覧を取得する
  3. キャンペーンの詳細画面を取得する

共通パラメータ

キャンペーンAPIの利用には共通のAPIキーの設定が必要です。 以下のパラメータをHTTPヘッダーに追加します。

x-tapi-key	"gijutsu5"
x-tuser-key	"1008"

取得情報

キャンペーンAPIで取得できる情報は以下の通りです。取得情報は全機能共通です。

string
キー名データ型説明
dataobjectキャンペーン情報が入ります
idnumberキャンペーンID
titleキャンペーン名称
descriptionstring概要
campaign_urlstringキャンペーン詳細ページURL
image_urlstringキャンペーン画像URL
publish_atstring公開日(キャンペーンが抽選サイトに表示される日付)※
publish_at_unix_timestampnumber公開日UNIXタイムスタンプ
start_atstring応募開始日※
start_at_unix_timestampnumber応募開始日UNIXタイムスタンプ
end_atstring応募終了日※
end_at_unix_timestampnumber応募終了日UNIXタイムスタンプ
is_adultboolean成人向けフラグ
※ string型の日付は"YYYY年MM月DD日 HH時mm分SS秒"の形で取得されます。

1. 現在応募可能なキャンペーン一覧を取得する

現在応募可能なキャンペーン一覧を取得します。

エンドポイント

https://campaign.toranoana.jp/api/v1/campaign/opened

curlコマンドでの呼び出し

curl --header "x-tapi-key:gijutsu5" --header "x-tuser-key:1008" "https://campaign.toranoana.jp/api/v1/campaign/opened"

2. 応募期間を指定してキャンペーン一覧を取得する

特定の応募期間に応募できるキャンペーンの一覧を取得します。

エンドポイント

https://campaign.toranoana.jp/api/v1/campaign/search?start_at=YYYYMMDD&end_at=YYYYMMDD

curlコマンドでの呼び出し

curl --header "x-tapi-key:gijutsu5" --header "x-tuser-key:1008" "https://campaign.toranoana.jp/api/v1/campaign/search?start_at=20180901&end_at=20180930"

3. キャンペーンの詳細画面を取得する

一意のキャンペーン詳細情報を取得します。

エンドポイント

https://campaign.toranoana.jp/api/v1/campaign/:id
※:idは表示させたいキャンペーンのIDです。

curlコマンドでの呼び出し

curl --header "x-tapi-key:gijutsu5" --header "x-tuser-key:1008" "https://campaign.toranoana.jp/api/v1/campaign/:id"

APIへのご意見、ご要望は虎の穴ラボ公式twitterまでお願いいたします。

You can’t perform that action at this time.