2. ユーザー管理インターフェース
2.1 ユーザーログイン
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
システムにログインします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“257”
Yes
user_name
string
ユーザー名、サポート大文字、小文字、数字、特殊文字（@および.-_）の長さは50未満である必要があります
Yes
user_pwd
string
ユーザーパスワードには、大文字、小文字、特殊文字、数字の3種類の文字を含め、長さは8以上32以下とします。
Yes
verify_code
string
コードを確認します。ログインに3回失敗したときに使用します。
No
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
json
ユーザーのセッションID、すべてのAPIリクエストは、httpリクエストのヘッダに「セッションID」を含める必要があります。ログイン後30分経過しても何も操作されない場合は、自動的にセッションIDが失効し、再度ログインする必要があります。
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
session_id
string
セッションの識別
retry_times
int
ユーザーの残りのログイン回数
mod_passwd_flag
int
動作フラグ
リクエストアドレスの例
{
"msg_id":"257",
"user_name":"admin",
"user_pwd":"newpassword"
}レスポンスの例
{
"code": 0,
"data":
{
"session_id": "9111234567890",
"retry_times": 0,
"mod_passwd_flag": 0,
},
"msg": ""
}2.2 ユーザーログアウト
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
システムからログアウトします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“258”
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
string
Null
msg
string
結果の説明
リクエストの例
{
"msg_id":"258"
}レスポンスの例
{
"code": 0,
"data": "",
"msg": ""
}2.3 認証コードのリクエスト
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
認証コードをリクエストします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“1322”
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
string
検証コード文字列
msg
string
結果の説明
リクエストの例
{
"msg_id": "1322"
}レスポンスの例
{
"code": 0,
"data": "9865",
"msg": ""
}2.4 ユーザー認証情報の設定
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
ユーザー認証情報を設定します。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“269”
Yes
user_name
string
ユーザー名
Yes
is_authed
int
認証済みか？ 1：Yes
0：No
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
string
Null
msg
string
結果の説明
リクエストの例
{
"msg_id":"269",
"user_name": "userA",
"is_authed":0
}レスポンスの例
{
"code": 0,
"data": "",
"msg": ""
}2.5 ユーザー認証情報のQuery
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
ユーザー認証情報をQueryします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“270”
Yes
user_name
int
ユーザー名
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
string
Null
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
user_name
string
ユーザー名
is_authed
int
認証済みか？
auth_items
int
認証項目
リクエストの例
{
"msg_id":"270",
"user_name": "userA"
}レスポンスの例
{
"code": 0,
"data": {
"user_name": "userA",
"is_authed": 0,
"auth_items": 0
},
"msg": ""
}2.6 ユーザーパスワードの認証
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
ユーザーパスワードの認証
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“271”
Yes
username
string
ユーザー名
No
userpasswd
string
ユーザーパスワード
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
string
結果とユーザー名
msg
string
結果の説明
リクエストの例
{
"msg_id":"271",
"userpasswd":"123456"
}レスポンスの例
{
"code": 0,
"data": {
"result": 0,
"username": "userA",
},
"msg": ""
}2.7 ユーザー権限のQuery
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
ユーザー権限をQueryします。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“273”
Yes
user_name
int
ユーザー名
Yes
right_item
int
ユーザー権限の種類 1：画像表示権限
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
string
ユーザー権限情報
msg
string
結果の説明
フィールド情報(データ)
パラメーター
型
説明
user_name
string
ユーザー名
right_item
int
ユーザー権限の種類 1：画像表示権限
right_value
int
権限値 1：Yes
0：No
リクエストの例
{
"msg_id":"273",
"right_item":1
}レスポンスの例
{
"code": 0,
"data": {
"user_name": "admin",
"right_item":1,
"right_value":1
},
"msg": ""
}2.8 ユーザー権限の設定
インターフェースの説明
インターフェースのURL
https://${ip}:${port}/api/json
リクエストメソッド
POST
リクエストパラメーター形式
JSON
インターフェースの説明
ユーザー権限を設定します。
リクエストパラメーター
パラメーター
型
説明
必須
例
msg_id
string
“272”
Yes
user_name
string
ユーザー名
Yes
right_item
int
ユーザー権限の種類 1：画像表示権限
Yes
right_value
int
権限値 1：Yes
0：No
Yes
レスポンスパラメーター
パラメーター
型
説明
code
int
結果コード（0：成功）
data
string
結果とユーザー権限情報
msg
string
結果の説明
リクエストの例
{
"msg_id":"272",
"user_name": "admin",
"right_item":1,
"right_value":1
}レスポンスの例
{
"code": 0,
"data": "",
"msg": ""
}Last updated