BLE Device API

Ble Device API의 사용방법

1. Authentication Token 확인하기

WalkInsights의 모든 API를 사용하기 위해서는 authentication_token 이 필요합니다.

authentication_token을 알아내기 위해서 인증문서 Step 1을 참고합니다.

2. BLE Device API 사용하기

이제 Authentication Token을 이용해서 실제 BLE Signal API를 사용해보겠습니다

알고 있는 Authentication Token을 이용하여 어떻게 API를 사용하는 지 Get BLE Devices(이하 API 문서)를 통해서 URL 등을 확인할 수 있고 또 직접 시도해보실 수 있습니다.

API 문서를 통하여 확인할 수 있고 이 때 API 인증을 위하여 header에 2개의 key와 그 값을 같이 제출해야 합니다

header는 다음과 같습니다

key

value

x-user-token

authentication token

x-user-email

user email

❗️

Ble Device API를 사용할 때

ad_id parameter는 optional이 아닌 required 입니다.
만약 ad_id가 없이 request를 보내게 될 경우 Status Code가 200이 아닌 4xx를 리턴합니다

이 header를 WalkInsights API에 요청을 보낼 때 header로 같이 보내주면 정상적으로 API를 이용할 수 있습니다.

API를 통해 받을 수 있는 데이터 포맷은 다음과 같습니다.

이름

자료형

설명

row_key

String

Advertisement ID로 이루어진 row key

ad_id

String

Advertisement ID

os

String

SDK가 설치된 OS

device

String

SDK가 설치된 device