2.1 システムのAPI

2.1.1 バージョン番号の取得 (/api/v3/server/version)

概要

現在のシステムのバージョン番号を取得します。

リクエストアドレスの例

https://HOST:PORT/api/v3/server/version

リクエスト方法

GET

リクエストパラメーター

パラメーター名

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。1.3.1シグネチャ(sign)の計算の章を参照してください

timestamp

string

必須

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "desc": "",
    "data": {
        "edition": "1.10.0",
        "date": "20190617"
    }
}

レスポンスのフィールド

パラメーター名

説明

edition

string

バージョン番号

date

string

バージョンのリリース日

2.1.2 企業情報の取得 (/api/v1/company)

概要

企業情報を取得します。

リクエストアドレスの例

https://HOST:PORT/api/v1/company

リクエスト方法

GET

リクエストパラメーター

パラメーター名

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。1.3.1シグネチャ(sign)の計算の章を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 58,
        "name": "日本コンピュータビジョン",
        "logo": "5b238d7ec6681b0001466d5e",
        "background": "5b238d7ec6681b0001466d5f",
        "welcome": "日本コンピュータビジョンへようこそ ",
        "introduction": "独創性をもち、AIと人類の進歩を牽引する企業",
        "contact": "太郎",
        "createAt": "2020-05-28 17:31:32.0",
        "updateAt": "2020-06-28 15:57:55.0",
        "validFrom": "2018-06-15 00:00:00.0",
        "validTo": "2018-07-31 00:00:00.0",
        "createBy": 17,
        "threshold": 0.85,
        "language": "zh",
        "serviceConfig": ""
    }
}

レスポンスのフィールド

パラメーター名

説明

code

int

リターンコード

message

string

リターンメッセージ

data

object

データ

dataフィールドの説明

パラメーター名

説明

id

int

企業ID

name

string

企業名

logo

string

ロゴ ID

background

string

背景 ID

welcome

string

Welcomeメッセージ

introduction

string

企業プロフィール

threshold

float

顔認証の閾値

language

string

利用中の言語

serviceConfig

string

サービス構成

createBy

int

作成者 ID

contact

string

担当者

createAt

string

作成時間

updateAt

string

更新時間

validFrom

string

ライセンス有効開始時間

validTo

string

ライセンス有効終了時間

エラーレスポンスのフィールド

コード

メッセージ

説明

30001

Param Invalid

無効なパラメーターです

最終更新