2.11 認証レコード+API

認証レコード+APIを利用するには、「SenseLink Cloud ID Pack Annual Subscription（以下、ID Pack）の契約が必要です。

認証レコード+には、過去３ヶ月の認証レコードが保持できます。

2.11.1 顔認証&認証レコード+の生成 (api/v1/plus/record)

概要

顔写真データを SenseLink Cloud に送信し、サーバー顔認証を実施、認証レコードを"認証レコード+"に保存します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/plus/record

リクエスト方法

POOST

リクエストパラメーター

名前	形式	必須	説明
sn	String	Y	デバイスのシリアルナンバー
timestamp	int	Y	画像記録時間 （Unixのタイムスタンプ形式：1658136457）
timezone	String	N	”GMT+9:00“
threshold	float	N	顔認証の類似度のしきい値 [0, 1]の範囲 1:Nの利用時に、この値を利用 デフォルト：0.9
image	Object	Y	顔画像
process_mode	int	N	APIの処理モード 0：非同期、user_id を返さない。画像検索処理は非同期。 （0以外のパラメータは未サポート）
extend	Json String	N	認証レコードに入力できる拡張項目。 サイズは最大1K Byte

image objectについて

名前	形式	必須	説明
data	String	Y	Base64でエンコードされた顔画像 制限：1MByte以下、フォーマットはJPG/PNGであること
rectangle	Object	N	画像内の領域範囲の指定。 領域内の最も大きい顔を検出。下記4つのパラメータを指定。

rectangleで指定するパラメータ

名前	形式	必須	説明
top	int	N	領域の最上部
left	int	N	領域の左端
width	int	N	領域の幅
height	int	N	領域の高さ

レスポンスフィールド

名前	形式	説明
code	int
message	string
data	object

dataフィールド

名前	形式	説明
record_id	long	認証レコードのID
image_id		認証レコードのスナップショットのID

リクエスト

{
    "sn":"JKQ00009234",
    "timestamp": 1659423903029,
    "threshold": 0.92,
    "extend":"{\"device_name\":\"xxxxx\"}",
    "image":{
        "data":"base64 encode image",
        “/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJ
    　　　　　　　　　        <中略>
         SdP0ykG0WjdF3AfoumAO6DRmyYC5SQ//2Q==“
        "rectangle":{
            "top":12,
            "left":32,
            "width":84,
            "height":23
        }
    }
}

レスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
       "record_id":930490000,
       "image_id": "5fceef6e1ddb2800010d1409"
}

2.11.2 認証レコード+ の取得 (/api/v1/plus/record)

概要

認証レコード+ を取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/plus/record

リクエスト方法

GET

リクエストパラメーター

名前	形式	必須	説明
time_from	string	Y	認証レコードの取得範囲の開始時刻（SenseLinkがレコードを保存した時刻） 例：2022-12-11T00:00:00+09:00
time_to	string	Y	認証レコードの取得範囲の終了時刻（SenseLinkがレコードを保存した時刻） 例：2022-12-11T23:59:59+09:00 制限：time_to - time_from で指定できる範囲は最大24時間まで。
sn	string	N	デバイスのシリアルナンバー
order	int	N	0：レコードIDで降順 1：レコードIDで昇順（デフォルトは0）
page	int	N	ページ番号（初期値は1）
size	int	N	各ページのエントリ数（デフォルトは20、最大は100）

通常のレスポンス

{
	"code": 200,
	"message": "OK",
	"data": {
		"page_num": 2,
		"page_size": 10,
		"total": 10,
		"list": [{
			"record_id": 1392523, // SenseLink CloudのレコードID
			"sn": "SN1234012345123", // デバイスのシリアルナンバー
			"image_id": "5fceef6e1ddb2800010d1409", // SenseLink Cloudの画像ID画像
			"user_id": 123, // SenseLink CloudのユーザーID
			"verify_score": 0.959, // 類似度のレベル
			"device_timestamp":130000000, // デバイスのタイムスタンプ
			"timezone":"GMT+9:00", // デバイスのタイムゾーン
			"create_at":130000000, // SenseLink Cloudがレコードを生成した時間 
			"extend":"Json string" // デバイスの拡張情報
		}],
	}
}

2.11.3 認証レコード+ スナップショット取得 (/api/v1/plus/image/{image_id})

概要

認証レコード+に登録された、認証レコードのスナップショットデータを取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/plus/image/{image_id}

リクエスト方法

GET

リクエストパラメーター

名前	形式	必須	説明
{image_id}	string	Y	認証レコード+に登録された、認証レコードのイメージID

通常のレスポンス

顔写真のバイナリーストリームデータ