BLE Session API_JP

BLE Session APIの使い方

1. Authentication Token を確認

WalkInsightsのAPIを利用するためにはauthentication_tokenが必要です。

authentication_tokenを取得するために、こちらの認証ドキュメント をご確認ください。

2. BLE Session APIを利用する

では、実際にAuthentication Tokenを使用し、BLE Session APIを利用してみましょう。

Authentication Tokenを使用して、どのようにAPIを使うのか Get BLE Signals(以下、APIドキュメント)を通してURLなどを確認できます。また、直接APIを使用することもできます。

この時、API認証のためにheaderに2つのkeyと値のセットを渡す必要があります。

headerは以下を参考にしてください。

key
x-user-tokenauthentication token
x-user-emailuser email

WalkInsights APIをコールするときにheaderに上記keyと値を含めてリクエストを送信することで、APIを利用することができます。

APIで取得可能なデータフォーマットは以下の通りです。

プロパティタイプ説明
row_keyString<shop_id>:<RTS>:<エリア>の形で表されたrow key
ad_idStringAdvertisement ID
customer_idString顧客が定義したID
dwell_timeInteger滞在時間
areaStringエリア
shop_idIntegershop ID
tsStringtimestamp