Safie Developers 仕様変更のお知らせ


いつもSafie Developers(https://developers.safie.link/)をご利用いただきありがとうございます。来月のバージョンアップに伴い、以下の仕様変更を予定しておりますので、事前にお知らせいたします。

変更予定日

2026年5月21日(木)を予定しています。

変更内容

1. Devices/デバイス一覧取得の仕様変更

1. Devices v2/デバイス一覧取得APIにおいて、任意のリクエストパラメータとして「device_id」を追加します。

2. Devices v2/デバイス一覧取得APIにおいて、レスポンスにパラメータ「capabilities」を追加します

【変更前】

HTTP/1.1 200 OK
Content-Type: application/json
{
 (略)
 "list": [
  {
   "device_id": "123456789abcdefg",
   "model": {
   "description": "Model Name"
  },
  "serial": "123456789abcdefg",
  "setting": {
   "name": "setting_name"
  },
  "status": {
   "video_streaming": true
   }
  }
  ],
 (略)
}

【変更後】

【レスポンス例 すべてのcapabilityに対応するデバイス】
HTTP/1.1 200 OK
Content-Type: application/json
{
 (略)
 "list": [
  {
   "device_id": "123456789abcdefg",
   "model": {
    "description": "Model Name"
   },
   "serial": "123456789abcdefg",
   "setting": {
    "name": "setting_name"
   },
   "status": {
    "video_streaming": true
   },
   "capabilities":[
    "gps",
    "ptz",
    "ptz_home",
    "ptz_centering",
    "still_capture"
   ]

  }
 ],
 (略)
}

2. 422エラーメッセージのレスポンスボディを変更します

エラーメッセージのスキーマを変更します

【変更前】

HTTP/1.1 422 Validation Error
Content-Type: application/json
{
 "detail": [
 {
  "loc": [
  "query",
  "start"
  ],
  "msg": "field required",
  "type": "value_error.missing"
  }
 ]
}

【変更後】

HTTP/1.1 422 Validation Error
Content-Type: application/json
{
 "detail": {
  "loc": [
   "query",
   "start"
  ],
 "message": "Parameter validation failed",
 "type": "validation_error"
 }

}

3. Entrance v2 APIの仕様変更

Entrance v2でQRコードの取り扱いが可能になります

1. Entrance v2 / QRコード利用者登録を新設

Safie APIにてQRコード利用者の登録が可能になります。

2. Entrance v2 / QRコード画像取得を新設

Safie APIにてQRコードの画像が取得可能になります。

3. Entrance v2 / 利用者一覧取得の仕様変更

1. 利用者一覧取得APIのリクエストに任意パラメータ「person_auth_type」を追加します

2. 利用者情報取得APIのレスポンスにQRコードに関するパラメータを追加します

【変更前】

HTTP/1.1 200 OK
Content-Type: application/json
{
 "count": 1,
 "has_next": false,
 "list": [
  {
   "name": "セーフィー太郎",
   "person_id": 1
  }
 ],
 "offset": 0,
 "total": 1
}

【変更後】

HTTP/1.1 200 OK
Content-Type: application/json
{
 "count": 1,
 "has_next": false,
 "list": [
  {
   "person_id": 1,
   "name": "セーフィー太郎",
   "qrcode_enabled": false
  ],
 "total": 1,
 "offset": 0,
}

4. Entrance v2 / 入退場一覧取得の仕様変更

入退場一覧取得APIのレスポンスにQRコードに関するパラメータを追加します

【変更前】

HTTP/1.1 200 OK
Content-Type: application/json
{
 "count": 1,
 "has_next": false,
 "list": [
  {
   "detection_id": 1,
   "is_allowed": true,
   "is_offline": false,
   "is_recognized": true,
   "person": {
    "name": "セーフィー太郎",
    "person_id": 1
   },
  "temperature": 36.5,
  "terminal": {
   "name": "本社エントランス",
   "serial": "5C00R000001",
   "terminal_id": 1
   },
  "timestamp": "2022-06-01T12:00:00+09:00"
  }
 ],
 "offset": 0,
 "total": 1
}

【変更後】

HTTP/1.1 200 OK
Content-Type: application/json
{
 "count": 1,
 "has_next": false,
 "list": [
  {
   "detection_id": 1,
   "is_allowed": true,
   "is_offline": false,
   "is_recognized": true,
   "person": {
    "name": "セーフィー太郎",
    "person_id": 1,
    "qrcode_enabled": false
   },
  "recognization_type": "face",
  "temperature": 36.5,
  "terminal": {
   "name": "本社エントランス",
   "serial": "5C00R000001",
   "terminal_id": 1
   },
  "timestamp": "2022-06-01T12:00:00+09:00"
  }
 ],
 "offset": 0,
 "total": 1
}

5. Entrance v2 / 利用者情報取得の仕様変更

利用者情報取得APIのレスポンスにQRコードに関するパラメータを追加します

【変更前】

HTTP/1.1 200 OK
Content-Type: application/json
{
 "person_id": 1,
 "name": "セーフィー太郎",
 "admittance_ids": [
  1
 ]
}

【変更後】

HTTP/1.1 200 OK
Content-Type: application/json
{
 "person_id": 1,
 "name": "セーフィー太郎",
  "admittance_ids": [
  1
 ],
 "available_from": "2026-04-01T00:00:00+09:00",
 "available_to": "2026-04-01T23:59:59+09:00",
 "delete_after_expiration": true,
 "qrcode": "XXXXXXXXXX"

}

ご質問

上記の通り仕様変更を予定しています。お使いいただいている機能が変更されますので、ご注意くださいませ。

また変更内容に関する事前のご質問・お問い合わせについては、お問い合わせフォーム(https://safie.jp/contact/api/)よりご連絡ください。

お客様にご満足いただけるサービスを提供できるよう引き続き努めてまいりますので、今後ともよろしくお願い申し上げます。

●2026年4月24日追記

2026年4月24日にEntranceの仕様変更を追記しました。

——

セーフィー株式会社
Safie Developers サポート窓口
平日10:00~17:00(土日祝祭日、年末年始等を除く)

この記事のカテゴリ