APIアクセスキー

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

APIアクセスキーとは

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

発行

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

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

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

注意

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

削除

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

注意

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

JSONデータの取得

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

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

• プロトコル
  HTTPS

• 文字コード
  UTF-8

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

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

• ステータスコード

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

最新位置情報

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

• HTTTPメソッド
  get

• URL
  /connect/latest

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

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

  コード	レスポンスヘッダー
  200	Content-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?リクエストパラメーター

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

  ① 日付のみを指定する(3月廃止予定)

  キー	項目名	設定内容	使用例
  date	日付	yyyyMMdd	date=20250106

  ② 日時・グループ・ユーザーで絞り込む※1

  キー	項目名	設定内容	使用例
  start	開始日時	yyyyMMddHHmmss ※2	start=20250106000000
  end	終了日時	yyyyMMddHHmmss ※2,※3	end=20250107121314
  group	グループ	グループ名	group=グループ1
  user	ユーザー	ユーザーID※4	user=1

  ※1 dateが設定されていた場合dateが優先
  ※2 拠点のタイムゾーンで設定、必須項目、start以上end未満が検索対象
  ※3 開始日時から終了日時まで24時間以内であること
  ※4 以下の優先順位で設定

  1. userの指定あり → ユーザー単位
  2. groupの指定あり → グループ単位
  3. どちらも未設定 → 全体
  注意

  ①日付のみを指定するパラメーターは2025年4月末をもって廃止いたします。
  ご利用の方は②のパラメーターに移行をお願いいたします。

  移行方法の例（date=20250106を利用していた場合）
  　　start=20250106000000&end=20250107000000

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

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

  • レスポンスボディ

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

  • users内オブジェクトの型

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

  注意

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