APIキー取得

APIキーを取得するためのAPIです。Managerのログイン画面での操作に相当します。

書式

curl -X POST --header 'Content-Type: application/json'

--header 'Accept: application/json'

-d 'JSON形式のリクエストボディ'

'http://ホスト名:ポート番号/api/v1/login'

リクエストボディ(JSON形式)

{

"userName": "string",

"password": "string"

}

リクエストパラメータ(JSON形式)
項目名 リクエストパラメータ 省略値
ユーザー名 userName 文字列

1文字以上、64文字以下

省略不可
パスワード password 文字列 1文字以上、64文字以下 省略不可
レスポンス

{

"apiKey": "string",

"expiresOn": 0,

"userId": "string",

"clientSecret" : "string"

}

レスポンスパラメータ
項目名 レスポンスパラメータ
APIキー apiKey 文字列 APIのリクエストヘッダーにセットするキーが返却されます。
APIキーの有効期限 expiresOn 数値

エポック時間がミリ秒で返却されます。

(1970年1月1日0時0分0秒からのミリ秒数)

例:1517107653277

ユーザーID userId 文字列  
再発行キー clientSecret 文字列

このキーをAPIキー再取得APIに入力することで、パスワードとユーザー名を使わずにAPIキーを再取得できます。