Skip to main content

APIアクセスキー

現在発行されているAPIアクセスキーの一覧が表示されます。

APIアクセスキー一覧画面
APIアクセスキーとは

発行したアクセスキーを利用することで拠点のJSONデータを取得することができます。
こちらはオプション機能です。使用したい場合は営業までお問い合わせください。

発行​

＋ボタンをクリックすることでAPIアクセスキーの発行画面が表示されます。
発行画面表示後は以下の手順で発行してください。

①［有効期限］を選択する。
② 発行ボタンをクリックする。

表示されたアクセスキーはコピーボタンをクリックし必ずコピーしてください。
コピー後は閉じるボタンで画面を閉じてください。

caution

表示されたAPIアクセスキーを一度閉じると再表示ができません。
必ずコピーしてから閉じてください。
また、アクセスキーがアクセスキーが流出した場合、第3者が測定データを取得する事が出来てしまいます。
厳重に管理をお願いいたします。
もし流出の可能性がある場合は、一度アクセスキーを削除し、再度発行して下さい。

登録

削除​

APIアクセスキー一覧で削除したいキーの右端のゴミ箱ボタンをクリックすることで確認画面が表示されます。
操作手順に従って削除してください。

削除
注意

削除すると該当のアクセスキーは使用できなくなります。

JSONデータの取得​

APIアクセスキーを利用することで拠点毎の[最新位置情報][移動履歴]のデータをJSON形式で取得することができます。
データを取得する際は下記仕様を確認しご利用ください。

最新位置情報・移動履歴の共通仕様​

  • プロトコル
    HTTPS

  • 文字コード
    UTF-8

  • 認証
    HTTPリクエストのヘッダーにアクセスキーを付与

    キー設定内容
    authorizationBearer <事前に発行したAPIアクセスキー>

  • ステータスコード

    コード内容
    400リクエストパラメータが有効な形式でない場合。
    401認証に失敗した場合。存在しないアクセスキー、失効済み、有効期限切れなど。
    500サーバ側でエラー発生した場合。

最新位置情報​

ユーザーの最新位置情報を返します。当日の測定データがないユーザーは対象外となります。
一件もデータが存在しない場合は、usersが空配列のレスポンスを返します。

  • HTTTPメソッド
    get

  • URL
    /connect/latest

  • リクエストパラメーター
    なし

  • レスポンス
    正常に取得できた場合、以下のレスポンスを返却

    コードレスポンスヘッダー
    200Content-Type:application/json

    • レスポンスボディ

      キー名項目名型内容並び順
      expiredAtアクセスキーの有効期限文字列書式：ISO8601形式
      usersユーザー情報配列ユーザー数分繰り返し

    • users内オブジェクトの型

      キー名項目名型内容並び順
      userIdユーザーID文字列1:昇順
      userNameユーザー名文字列
      endユーザー名nullまたは文字列測定中はnull、測定終了時は書式：ISO8601形式
      groupNameグループ名文字列
      dateTime測定日時文字列書式：ISO8601形式
      xレイアウト上のx座標数値
      yレイアウト上のy座標数値
      areaNameエリア名文字列
      floorレイアウト上の階数数値
    注意

    レスポンスのキーは今後増える場合がございます。

移動履歴​

ユーザーの移動履歴の情報を返します。当日の測定データがないユーザーは対象外となります。
一件もデータが存在しない場合は、usersが空配列のレスポンスを返します。

  • HTTTPメソッド
    get

  • URL
    connect/locations?date=yyyyMMdd

  • リクエストパラメーター

    キー項目名設定内容
    date日付yyyyMMdd

  • レスポンス
    正常に取得できた場合、以下のレスポンスを返却

    コードレスポンスヘッダー
    200Content-Type:application/json

    • レスポンスボディ

      キー名項目名型内容並び順
      expiredAtアクセスキーの有効期限文字列書式：ISO8601形式
      departmentName拠点名文字列
      usersユーザー情報配列ユーザー数分繰り返し

    • users内オブジェクトの型

      キー名項目名型内容並び順
      userIdユーザーID文字列1:昇順
      userNameユーザー名文字列
      groupNameグループ名文字列
      dateTime測定日時文字列書式：ISO8601形式2:昇順
      xレイアウト上のx座標数値
      yレイアウト上のy座標数値
      areaNameエリア名文字列
      floorレイアウト上の階数数値
      activityLevel活動レベル数値
    注意

    レスポンスのキーは今後増える場合がございます。