Open API Docs
- パスワード
- 施錠記録
  - 施錠記録リストの取得
- ステータスコード

Open API Doc

アクセストークンを取得

リクエストメソッド：GET

クエリ： https://open.populife.co/api/auth/access_token/get

クエリ：パラメータ	タイプ	必須	ディスクリプション	例 e.g.
appKey	string	はい	オープンプラットフォーム「Populife」から取得したApp Key	9JQJEPC0ZR9TC4
appSecret	string	はい	オープンプラットフォーム「Populife」から取得したApp Secret	b8047ecdb32dca1b0a6d5133fae43c60

インストラクション：

アクセストークンとは、アプリケーションがPopulifeのAPIにアクセスするための認証です。取得したアクセストークンの有効期間は2時間です。再度アクセストークンを取得すると、有効期間が更新されます。また、前回取得したアクセストークンは無効になります。繰り返しの呼び出しによるリソースの浪費を避けるために、アクセストークンを限られた時間、ローカルサーバーにキャッシュします。

レスポンスボディの例

                                {
    "success": true,
    "code": 200,
    "msg": null,
    "data": {
        "expire": 7200,
        "accessToken": "NzMyNmU4MGJjYTk3OTgzODJmYzlhOTc0NWQxMzBlNzFmNTZhMTlmNTdkYjQ2NDFmNmM1OWZiM2JlOTI0ZjE2MQ=="
    }
}

レスポンスボディパラメータ	ディスクリプション	タイプ
data.expire	有効時間（単位：秒）	number
data.accessToken	オープンプラットフォーム「Populife」から取得したアクセストークン	string

デバイスのリストを取得

リクエストメソッド：GET

クエリ： https://open.populife.co/api/lock/list

クエリ：パラメータ	タイプ	必須	ディスクリプション	例 e.g.
appKey	string	はい	オープンプラットフォーム「Populife」から取得したApp Key	9JQJEPC0ZR9TC4
accessToken	string	はい	オープンプラットフォーム「Populife」から取得したアクセストークン	1OWZiM2JlOTI0ZjE2MQ...==
pageNo	string	はい	ページ番号、1から始まる	1
pageSize	string	はい	1ページあたりの行数	20

インストラクション：

現在のAppKeyアカウントが所有するすべてのデバイスリストの情報を照会します。 PopulifeからAppKeyとAppSecretを入手後、Populifeアプリで登録したユーザーアカウントをPopulifeサポートチームに提供してください。 Populifeサポートチームがお客様のPopulifeアプリのユーザーアカウントとAppKeyの関連付けを行います。最後に、このAPIを通じてPopulifeアプリのエンタープライズ関連ユーザーのデバイスリスト情報を照会することができます。デバイス情報を取得後、パスワードAPIを使ってデバイスの解錠パスワードを作成することができます。

レスポンスボディの例

                                {
    "success": true,
    "code": 200,
    "msg": null,
    "data": [
        {
            "lockId": 723716,
            "name": "PPL-ML-E6DE5",
            "alias": "PPL-ML-E6DE5",
            "mac": "C4:E8:4D:34:32:A5",
            "electricQuantity": 100,
            "modelNum": "SN138_PPL-DB",
            "hardwareRevision": "1.0",
            "firmwareRevision": "1.0.0.1108",
            "initDate": 1623314021000
        }
    ]
}

レスポンスボディパラメータ	ディスクリプション	タイプ
data.hardwareRevision	デバイスのハードウェアバージョン	string
data.lockId	Populifeデバイスのデジタルアイデンティティ	number
data.name	デバイスのBluetooth名（デバイス追加時にBluetoothでスキャンされたシリアルナンバーのことです）	string
data.alias	デバイスのエイリアス	string
data.mac	MACアドレス	string
data.electricQuantity	バッテリー残量（％）非リアルタイムで更新、最終アプリでBluetooth同期後バッテリー残量のデータ	number
data.modelNum	デバイスモデル	string
data.firmwareRevision	デバイスのファームウェアバージョン	string
data.initDate	ユーザーがアプリでデバイスを初期化した時間	number

転送ロック

リクエストメソッド：POST

クエリ：https://open.populife.co/api/lock/transfer

クエリ：パラメータ	タイプ	必須	ディスクリプション	例 e.g.
appKey	string	はい	オープンプラットフォーム「Populife」から取得したApp Key	9JQJEPC0ZR9TC4
accessToken	string	はい	オープンプラットフォーム「Populife」から取得したアクセストークン	1OWZiM2JlOTI0ZjE2MQ...==
lockIds	string	はい	ロック ID (1 つ以上、複数は、で区切られます)	2059328,2059901,12695599
recUsername	string	はい	受取人のユーザー名（ポピュライフアプリに登録されているメールアドレスまたは携帯電話番号）	a49871322@gmail \| +1638472744948

インストラクション：

このインターフェイスは、現在の企業のロックを Populife ユーザーアカウントに転送するのに適しています。転送されたロックの所有権はターゲットに属し、回復することはできません。注意して使用してください。

レスポンスボディの例：

                                {"success":true,"code":200,"msg":null,"data":null}

パスワードリストを取得

リクエストメソッド：GET

クエリ： https://open.populife.co/api/password/list

クエリ：パラメータ	タイプ	必須	ディスクリプション	例 e.g.
appKey	string	はい	オープンプラットフォーム「Populife」から取得したApp Key	9JQJEPC0ZR9TC4
accessToken	string	はい	オープンプラットフォーム「Populife」から取得したアクセストークン	1OWZiM2JlOTI0ZjE2MQ...==
lockId	string	はい	Populifeデバイスのデジタルアイデンティティ	3212108
pageNo	string	はい	ページ番号、1から始まる	1
pageSize	string	はい	1ページあたりの行数	20

インストラクション：

ユーザーの1つのデバイスのパスワードリストの取得

レスポンスボディの例

                                {
    "success": true,
    "code": 200,
    "msg": null,
    "data": [
        {
            "keyboardPwdId": 43859773,
            "keyboardPwd": "06607711",
            "keyboardPwdType": 2,
            "startDate": null,
            "endDate": null,
            "createDate": 1590485654000,
            "alias": "Home",
            "sendUser": " 8613201812820",
            "status": 2
        }, {
            "keyboardPwdId": 43859772,
            "keyboardPwd": "06600532",
            "keyboardPwdType": 3,
            "startDate": 1590485653860,
            "endDate": 1590485721300,
            "createDate": 1590485654000,
            "alias": "Office",
            "sendUser": " 8613201812820",
            "status": 2
        }
    ]
}

レスポンスボディパラメータ	ディスクリプション	タイプ
data.keyboardPwdType	パスワードタイプ（1：ワンタイム、2：無制限、3：期間限定、4：カスタマイズ）	number
data.keyboardPwdId	パスワードID	number
data.keyboardPwd	パスワード数字	string
data.startDate	実効アクセス時間、GMT+8	number
data.endDate	パスワード無効タイムスタンプ、GMT+8	number
data.sendUser	パスワードの作成者	string
data.createDate	パスワードの作成時間	number
data.alias	パスワードのエイリアス	string
data.status	パスワードの状態（0：削除、1：待機中、2：無効、3：有効）	number

期間限定パスワードを作成

リクエストメソッド：POST

クエリ： https://open.populife.co/api/password/generate/deadline

ヘッダーパラメータ	タイプ	必須	ディスクリプション	例 e.g.
Content-Type	string	はい		application/x-www-form-urlencoded;charset=utf-8

ボディパラメータ	タイプ	必須	ディスクリプション	例 e.g.
appKey	string	はい	オープンプラットフォーム「Populife」から取得したApp Key	9JQJEPC0ZR9TC4
accessToken	string	はい	オープンプラットフォーム「Populife」から取得したアクセストークン	1OWZiM2JlOTI0ZjE2MQ...==
lockId	string	はい	Populifeデバイスのデジタルアイデンティティ	371920
startDate	string	はい	パスワード有効時間（年月日時）	2018-08-12 12:00
endDate	string	はい	パスワード無効時間（年月日時）	2018-08-13 13:00
timeZone	string	はい	パスワード有効タイムゾーン	8
alias	string	いいえ	パスワードのエイリアス	Home

インストラクション：

指定デバイスの解錠パスワードを作成、指定された期間のみ有効とします。各初期化後、同一デバイスに対して、同一有効期間（同じく有効期間と無効期間）内に期間限定パスワード1つだけ作成いただけます。期間限定パスワードは、有効時間開始から最初の24時間以内にせめて一回使用しないと、自動的に無効になります。最大150個の有効パスワード（全種類）を一つのデバイスに保有することができます。期間限定パスワードの時間精度は時間単位となります（1時間ごとに有効、無効します）。国や地域に応じて、正しいGMTタイムゾーンを設定してください。

レスポンスボディの例

                                {
    "success": true,
    "code": 200,
    "msg": null,
    "data": {
        "keyboardPwdId": 109954189,
        "keyboardPwd": "93157137"
    }
}

レスポンスボディパラメータ	ディスクリプション	タイプ
data.keyboardPwdId	パスワードID	number
data.keyboardPwd	パスワード数字	string

無制限パスワードを作成

リクエストメソッド：POST

クエリ： https://open.populife.co/api/password/generate/permanent

ヘッダーパラメータ	タイプ	必須	ディスクリプション	例 e.g.
Content-Type	string	はい		application/x-www-form-urlencoded;charset=utf-8

ボディパラメータ	タイプ	必須	ディスクリプション	例 e.g.
appKey	string	はい	オープンプラットフォーム「Populife」から取得したApp Key	9JQJEPC0ZR9TC4
accessToken	string	はい	オープンプラットフォーム「Populife」から取得したアクセストークン	1OWZiM2JlOTI0ZjE2MQ...==
lockId	string	はい	Populifeデバイスのデジタルアイデンティティ	371920
alias	string	いいえ	パスワードのエイリアス	Home

インストラクション：

とあるデバイスに永久的に有効パスワードを作成（パスワードは削除またはデバイスをリセットしない限り永久有効である）期間限定パスワードは、有効時間開始から最初の24時間以内にせめて一回使用しないと、自動的に無効になります。最大150個の有効パスワード（全種類）を一つのデバイスに保有することができます。

レスポンスボディの例

                                {
    "success": true,
    "code": 200,
    "msg": null,
    "data": {
        "keyboardPwdId": 109954189,
        "keyboardPwd": "93157137"
    }
}

レスポンスボディパラメータ	ディスクリプション	タイプ
data.keyboardPwdId	パスワードID	number
data.keyboardPwd	パスワード数字	string

ワンタイムパスワードを作成

リクエストメソッド：POST

クエリ： https://open.populife.co/api/password/generate/oneTime

ヘッダーパラメータ	タイプ	必須	ディスクリプション	例 e.g.
Content-Type	string	はい		application/x-www-form-urlencoded;charset=utf-8

ボディパラメータ	タイプ	必須	ディスクリプション	例 e.g.
appKey	string	はい	オープンプラットフォーム「Populife」から取得したApp Key	9JQJEPC0ZR9TC4
accessToken	string	はい	オープンプラットフォーム「Populife」から取得したアクセストークン	1OWZiM2JlOTI0ZjE2MQ...==
lockId	string	はい	Populifeデバイスのデジタルアイデンティティ	371920
alias	string	いいえ	パスワードのエイリアス	Home

インストラクション：

とあるデバイスにワンタイムパスワードを作成、ワンタイムパスワードは、作成後6時間以内一回使用しないと、自動的に無効になります。最大150個の有効パスワード（全種類）を一つのデバイスに保有することができます。

レスポンスボディの例

                                {
    "success": true,
    "code": 200,
    "msg": null,
    "data": {
        "keyboardPwdId": 109954189,
        "keyboardPwd": "93157137"
    }
}

レスポンスボディパラメータ	ディスクリプション	タイプ
data.keyboardPwdId	パスワードID	number
data.keyboardPwd	パスワード数字	string

カスタム有効期限付きパスワード生成

リクエストメソッド：POST

クエリ：https://open.populife.co/api/password/custom/deadline

ヘッダーパラメータ	タイプ	必須	説明	例 e.g.
Content-Type	string	はい		application/x-www-form-urlencoded;charset=utf-8

ボディパラメータ	タイプ	必須	説明	例 e.g.
appKey	string	はい	Populifeオープンプラットフォームから提供されるアプリケーションキー	9JQJEPC0ZR9TC4
accessToken	string	はい	Populifeオープンプラットフォームから認可されたアクセストークン	1OWZiM2JlOTI0ZjE2MQ...==
lockId	string	はい	Populifeロック製品の数値識別子	371920
keyboardPwd	string	はい	カスタムキーパッドパスワード(6-9桁の数字)	88991
startDate	string	はい	キーパッドパスワードの有効開始時間（年月日時）	2018-08-12 12:00
endDate	string	はい	キーパッドパスワードの有効期限終了時間（年月日時）	2018-08-13 13:00
timeZone	string	はい	パスワード有効期間のタイムゾーン	8
alias	string	いいえ	パスワードの別名	Home

詳細説明：

あるロックに基づいて、カスタムの時間制限付きパスワード（6～9桁の純数字）を生成する。時間制限付きパスワードの時間精度は時間単位（00分の整点に有効および無効）である。1つのロック内に同時に保存できる有効なパスワード（すべてのパスワードタイプを含む）の総数は150を超えない。

レスポンス例：

{
"success": true,
"code": 200,
"msg": null,
"data": {
"keyboardPwdId": 109954189
}
}

レスポンスボディパラメータ	説明	タイプ
data.keyboardPwdId	パスワードID	number

カスタム永久パスワード生成

リクエストメソッド：POST

クエリ：https://open.populife.co/api/password/custom/permanent

ヘッダーパラメータ	タイプ	必須	説明	例 e.g.
Content-Type	string	はい		application/x-www-form-urlencoded;charset=utf-8

ボディパラメータ	タイプ	必須	説明	例 e.g.
appKey	string	はい	Populifeオープンプラットフォームから提供されるアプリケーションキー	9JQJEPC0ZR9TC4
accessToken	string	はい	Populifeオープンプラットフォームから認可されたアクセストークン	1OWZiM2JlOTI0ZjE2MQ...==
lockId	string	はい	Populifeロック製品の数値識別子	371920
keyboardPwd	string	はい	カスタムキーパッドパスワード(6-9桁の数字)	88991
alias	string	いいえ	パスワードの別名	Home

詳細説明：

特定のロックに対して、カスタム永久パスワード(6-9桁の数字)を生成します。1つのロック内に同時に保存できる有効なパスワード（すべてのパスワードタイプ）の総数は150個を超えることはできません。

レスポンス例：

{
"success": true,
"code": 200,
"msg": null,
"data": {
"keyboardPwdId": 109954189
}
}

レスポンスボディパラメータ	説明	タイプ
data.keyboardPwdId	パスワードID	number

パスワード数字の変更

リクエストメソッド：POST

クエリ：https://open.populife.co/api/password/change/code

ヘッダーパラメータ	タイプ	必須	説明	例 e.g.
Content-Type	string	はい		application/x-www-form-urlencoded;charset=utf-8

ボディパラメータ	タイプ	必須	説明	例 e.g.
appKey	string	はい	Populifeオープンプラットフォームから提供されるアプリケーションキー	9JQJEPC0ZR9TC4
accessToken	string	はい	Populifeオープンプラットフォームから認可されたアクセストークン	1OWZiM2JlOTI0ZjE2MQ...==
lockId	string	はい	Populifeデバイスのデジタルアイデンティティ	3212108
keyboardPwdId	string	はい	キーパッドパスワードID	1920
keyboardPwd	string	はい	キーパッドパスワード(6-9桁の数字)	88991

詳細説明：

カスタムキーパッドパスワードは、ゲートウェイがオンラインであればいつでも変更できます。ランダムに生成されたパスワードは、ゲートウェイがオンラインで、かつそのパスワードが少なくとも1回使用されている場合にのみ変更が許可されます。

レスポンス例：

{
"success": true,
"code": 200,
"msg": "変更に成功しました",
"data": null
}

パスワード有効期限の変更

リクエストメソッド：POST

クエリ：https://open.populife.co/api/password/change/deadline

ヘッダーパラメータ	タイプ	必須	説明	例 e.g.
Content-Type	string	はい		application/x-www-form-urlencoded;charset=utf-8

ボディパラメータ	タイプ	必須	説明	例 e.g.
appKey	string	はい	Populifeオープンプラットフォームから提供されるアプリケーションキー	9JQJEPC0ZR9TC4
accessToken	string	はい	Populifeオープンプラットフォームから認可されたアクセストークン	1OWZiM2JlOTI0ZjE2MQ...==
lockId	string	はい	Populifeデバイスのデジタルアイデンティティ	3212108
keyboardPwdId	string	はい	キーパッドパスワードID	1920
startDate	string	はい	キーパッドパスワードの有効開始時間（年月日時）	2018-08-12 12:00
endDate	string	はい	キーパッドパスワードの有効期限終了時間（年月日時）	2018-08-13 13:00
timeZone	string	はい	パスワード有効期間のタイムゾーン	8

詳細説明：

時間制限パスワードは開始/終了時間を変更可能で、時間精度は時間単位（00分の整点に有効/無効）であり、永久から時間制限に変更できます。循環パスワードは循環ルール（毎日/週の曜日/平日/日曜日）+ 開始終了時間を変更可能で、時間制限から循環に、または循環から時間制限に変更することはできません。

レスポンス例：

{
"success": true,
"code": 200,
"msg": "変更に成功しました",
"data": null
}

パスワード削除

リクエストメソッド：POST

クエリ：https://open.populife.co/api/password/delete

ヘッダーパラメータ	タイプ	必須	説明	例 e.g.
Content-Type	string	はい		application/x-www-form-urlencoded;charset=utf-8

ボディパラメータ	タイプ	必須	説明	例 e.g.
appKey	string	はい	Populifeオープンプラットフォームから提供されるアプリケーションキー	9JQJEPC0ZR9TC4
accessToken	string	はい	Populifeオープンプラットフォームから認可されたアクセストークン	1OWZiM2JlOTI0ZjE2MQ...==
lockId	string	はい	Populifeデバイスのデジタルアイデンティティ	3212108
keyboardPwdId	string	はい	キーパッドパスワードID	1920

詳細説明：

カスタムキーパッドパスワードは、ゲートウェイがオンラインであればいつでも削除できます。ランダムに生成されたパスワードは、ゲートウェイがオンラインで、かつそのパスワードが少なくとも1回使用されている場合にのみ削除が許可されます。

レスポンス例：

{
"success": true,
"code": 200,
"msg": "削除に成功しました",
"data": null
}

解錠記録リストの取得

リクエスト方法：GET

リクエストURL：https://open.populife.co/api/lockRecord/list

ヘッダーパラメータ	タイプ	必須	説明	例 e.g.
Content-Type	string	はい		application/x-www-form-urlencoded;charset=utf-8

ボディパラメータ	タイプ	必須	説明	例 e.g.
appKey	string	はい	Populifeオープンプラットフォームによって提供されるアプリケーションキー	9JQJEPC0ZR9TC4
accessToken	string	はい	Populifeオープンプラットフォームによって承認されたアクセストークン	1OWZiM2JlOTI0ZjE2MQ...==
lockId	string	はい	Populifeロック製品の数字識別子	371920
startDate	number	はい	開始タイムスタンプ（0は制限なしを意味する）	1775981754
endDate	number	はい	終了タイムスタンプ（0は制限なしを意味する）	1775991721
pageNo	number	はい	ページ番号（最小は1）	1
pageSize	number	はい	1ページあたりの記録数	20

詳細説明：

解錠記録リスト。

レスポンス例：

            {
    "success": true,
    "code": 200,
    "msg": null,
    "data": {
        "pageNo": 1,
        "pageSize": 2,
        "disablePre": true,
        "disableNext": false,
        "count": 31,
        "dataList": [
            {
                "lockId": 18277584,
                "recordType": 1,
                "username": "xxx@qq.com",
                "keyboardPwd": "",
                "operateTime": 1729493892000
            },
            {
                "lockId": 18277584,
                "recordType": 1,
                "username": "xxx@qq.com",
                "keyboardPwd": "",
                "operateTime": 1729493865000
            }
        ],
        "totalPage": 16,
        "beginPage": 1,
        "endPage": 10
    }
}

レスポンスボディパラメータ	説明	タイプ
data.pageNo	ページ番号、1から開始	number
data.beginPage	総ページ数	number
data.count	総レコード数	number
data.dataList	記録リスト	list

リスト内のオブジェクトを返す	説明	タイプ
lockId	ロックID	number
recordType	イベント、1：解錠、2：施錠、3：キーボードパスワード解錠、4：ゲートウェイ解錠、5：ゲートウェイ施錠、7：指紋解錠、8：ICカード解錠、9：誤ったパスワード解錠、10：NFC解錠	number
username	操作者のユーザー名（メールまたは電話番号）	string
keyboardPwd	キーボードパスワードまたはICカード番号	string
operateTime	操作時間	number

付録

ステータスコード

ステータスコード	ディスクリプション
200	成功
900	必須パラメータミッシング
500	サーバーエラー
910	無効なパラメータ