Skip to main content

チュートリアル

この項の目的​

このシステムの使用イメージを理解していただくことを目的とします。

基本的な購入までの API アクセスフローを示します。

本 API は大きく分けて 3 段階のフローが存在します。

  1. 購入の準備

  2. ガチャ商品の購入

  3. 商品の引き渡し

購入の準備​

ガチャを購入するにあたり、ガチャはビーコンもしくはエリアと紐づいている場合があります。この場合、ユーザはビーコンもしくはエリアを発見することでガチャの購入を行うことができます。

ユーザはビーコンから特定の番号を取得してサーバに見つけたことをリクエストします。

サーバ側はユーザが見つけたビーコンを元にユーザがアクセス可能なガチャを特定します。

ユーザのサインアップ​

ユーザはそれぞれの認証方法に基づいてユーザが作成されます。サインアップをしていない状態でもガチャ情報を取得することは可能です。

POST /api/v1/users/signup

チェックイン(オプション)​

ガチャの設定で、Bluetoothビーコンの発見やGPSによる購入制限を設定することができます。ユーザはチェックインを行うことでガチャを購入する権利を一時的に得ることができます。

準備中

ビーコンの発見​

ユーザがそのビーコンを見つけたことをサーバにリクエストします。これにより一定期間、そのビーコン情報に紐づいたガチャ等を見つけることが可能になります。

POST /api/v1/beacons

エリアの発見​

ユーザがそのエリアを見つけたことをサーバにリクエストします。これにより一定期間、そのエリア情報に紐づいたガチャ等を見つけることが可能になります。

POST /api/v1/areas

注意

チェックインのセッションには有効期限が存在しています。有効期限が切れた場合、ユーザは購入権限を失うため再度チェックインを行うことで再度権限を得ることができます。

ガチャ商品の購入​

ユーザは自身の端末からデジタルガチャにアクセスして商品を購入します。

ガチャ一覧の取得​

ユーザの認証方式からアクセスできるガチャの一覧を取得します。

GET /api/v1/gachas

ガチャ詳細・商品情報の取得​

ユーザはガチャを選択して任意のガチャ詳細ページに遷移します。ここでは商品一覧情報を取得することを想定しています。

GET /api/v1/gachas/:gacha_id/prizes

ガチャ注文の作成​

ユーザが任意の回数のガチャ商品を購入するため注文を作成します。未決済の注文はユーザにつき、一つまで存在します。未決済の注文が既に存在する場合は前回の注文は削除され、新しい注文が作成されます。

POST /api/v1/gachas/:gacha_id/orders

決済の完了​

未決済状態の注文を決済済みにします。

GET /api/v1/orders/:order_id/payment

注文状況・抽選結果の確認​

決済完了後に注文の状態が更新されていることを確認します。決済済みのステータスの場合、抽選結果も表示されます。

GET /api/v1/orders/:order_id

商品の引き渡し​

ユーザは商品購入後にスタッフ等を通して商品を受け取ります。引き渡し方法は二つ存在します。引き渡し方法はガチャの設定ごとに設定できます。ユーザが選べるといった形を想定したものではありません。

引き渡し用 QR コードの作成​

引き渡しを行うための引き渡しコードを発行します。このコードはリクエストごとに発行され、リクエスト時点までの未引き渡し商品を引き換え対象にします。

注意

このコードは作成後 10 分間引き換え可能となります。失効した場合等は再度引き渡しコードの発行をリクエストしてください。ユーザが再度コードを発行した場合、それまでのコードは失効するためご注意ください。

引き渡しコードを元に QR コードをユーザ端末で作成して、スタッフに提示することで

GET /api/v1/pickups

郵送​

ユーザが購入した商品を後日指定住所まで郵送します。

各項目の詳細​

以下ではより詳細にAPIの使用方法を説明します。