BLE Signal API_JP
BLE Signal APIの使い方
1. Authentication Token を確認
WalkInsightsのAPIを利用するためにはauthentication_tokenが必要です。
authentication_tokenを取得するために、こちらの認証ドキュメント をご確認ください。
2. BLE Signal APIを利用する
では、実際にAuthentication Tokenを使用し、BLE Signal APIを利用してみましょう。
Authentication Tokenを使用して、どのようにAPIを使うのか Get BLE Signals(以下、APIドキュメント)を通してURLなどを確認できます。また、直接APIを使用することもできます。
この時、API認証のためにheaderに2つのkeyと値のセットを渡す必要があります。
headerは以下を参考にしてください。
| key | 値 |
|---|---|
| x-user-token | authentication token |
| x-user-email | user email |
WalkInsights APIをコールするときにheaderに上記keyと値を含めてリクエストを送信することで、APIを利用することができます。
APIで取得可能なデータフォーマットは以下の通りです。
| プロパティ | タイプ | 説明 |
|---|---|---|
| row_key | String | <shop_id>:<RTS>の形で表されたrow key |
| ad_id | String | Advertisement ID |
| customer_id | String | 顧客が定義したID |
| area | String | エリア |
| event | String | 発生したイベント |
| square_mac | String | square mac |
| ts | String | timestamp |
| shop_id | Integer | shop ID |
| rssi | Short | 信号の強さ |
| event_sent_at | Long | Push Eventを送ったtimestamp |
| event_opend_at | Long | Push Eventを確認したtimestamp |
Updated over 1 year ago
