BLE Device API_JP
BLE Device APIの使い方
1. Authentication Tokenを確認
WalkInsightsのAPIを利用するためにはauthentication_tokenが必要です。
authentication_tokenを取得するために、こちらの認証ドキュメント をご確認ください。
2. BLE Device 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 |
Ble Device APIの利用時ad_id パラメータは optionalではなくrequiredです。
ad_idパラメータを含めずにリクエストを送る場合、Status Codeが4xxでレスポンスされます。(200ではありません)
WalkInsights APIをコールするときにheaderに上記keyと値を含めてリクエストを送信することで、APIを利用することができます。
APIで取得可能なデータフォーマットは以下の通りです。
プロパティ | タイプ | 説明 |
|---|---|---|
row_key | String | Advertisement IDで作られたrow_key |
ad_id | String | Advertisement ID |
os | String | SDKが組み込まれているOS |
device | String | SDKが組み込まれているdevice |
Updated 8 months ago
