認証API#

リクエストヘッダ情報#

認証API用ヘッダー

項番	ヘッダー名	必須	ヘッダー値
1	Content-Type	○	application/json
2	X-FCX-Client-Cert	※注参照	ユーザー情報に紐づくクライアント証明書

※「証明書+パスワード認証」の場合のみ、必須

エラー情報#

API実行エラーの際、エラー情報はレスポンスのボディーに返却されます。

項番	項目名	型	多重度	説明
1	errorLevel	string	1..1	エラーレベル
2	framework	object	1..1	フレームワークオブジェクト
3	┗systemErrorCode	string	1..1	システムエラーコード
4	business	object	1..1	業務オブジェクト
5	┗businessErrorInfo	string	1..1	エラーメッセージ
6	┣responseErrorCode	string	1..1	応答エラーコード
7	┗embeddedString	string array	1..1	埋め込み情報

サンプル：

{
  "errorLevel": "888",
  "framework": {
    "systemErrorCode": ""
  },
  "business": {
    "businessErrorInfo": "Cannot create token from the specified user information.",
    "responseErrorCode": "RCM301802",
    "embeddedString": []
  }
}

返却されるエラー情報

項番	HTTPステータス	エラー内容	エラーメッセージ	エラーの原因
1	400	入力パラメータ異常	Parameter is invalid. Specified parameter: XXX※XXXはパラメータ名	入力パラメータチェックエラー（パラメータなし、桁数不備、形式不備など）
2	401	アクセストークン生成不可	Cannot create token from the specified user information.	リクエストで指定した情報に不備がある場合
3	500	アクセストークン払出失敗	Failed to create token (Internal Error).	サーバー内部エラー

API詳細#

アクセストークン取得を行う#

リクエスト

パラメータ定義

項番	項目名(英)	項目名(和)	必須	多重度	最小桁数	最大桁数	設定値の条件	説明
1	auth	認証	○	1..1	-	-	オブジェクト	認証オブジェクト
2	┗identity	アイデンティティ	○	1..1	-	-	オブジェクト	アイデンティティオブジェクト
3	┗password	パスワード	○	1..1	-	-	オブジェクト	パスワードオブジェクト
4	┗user	ユーザー	○	1..1	-	-	オブジェクト	ユーザーオブジェクト
5	┣contract_number	契約番号	○	1..1	8	8	半角文字列	認証ユーザーの契約番号
6	┣name	ユーザー名	○	1..1	4	246	半角文字列	認証ユーザーのユーザー名
7	┗password	パスワード	○	1..1	16	64	半角文字列	認証ユーザーのパスワード
8	timezone	タイムゾーン			-	-	半角文字列	タイムゾーンを指定します。（※大文字/小文字を区別しない）未指定または"UTC"以外及び無効なタイムゾーンを指定した場合は、"JST"が自動設定されます。

サンプル：

{
  "auth": {
    "identity": {
      "password": {
        "user": {
          "contract_number": "xxxxxxxx",
          "name": "user-name",
          "password": "user-password"
        }
      }
    }
  },
  "timezone": "UTC"
}

レスポンス

APIが正常に実行された時以下のレスポンスが返却されます。

HTTPステータス：201

ボディー部：

項番	項目名（英）	項目名（和）	多重度	説明
1	token	トークン	1..1	トークンオブジェクト
2	┣expires_at	有効期限	1..1	アクセストークンの有効期限です。初回払い出し時点での有効期限は30分後です。タイムゾーン：リクエスト項目の「timezone」に"UTC"を指定した場合は"UTC"、それ以外の場合は"JST" フォーマット： YYYY-mm-ddTHH:MM:SS.SSSZ（"UTC"の場合） YYYY-mm-ddTHH:MM:SS（"JST"の場合）
3	┣scope	スコープ	1..1	スコープ
4	┗user	ユーザー	1..1	ユーザーオブジェクト
5	┣contract_number	契約番号	1..1	認証ユーザーの契約番号
6	┗name	ユーザー名	1..1	認証ユーザーのユーザー名

サンプル：

{
  "token": {
   "expires_at": "2016-05-16T03:20:42",
    "scope": "paas",
    "user": {
      "contract_number": "xxxxxxxx",
      "name": "user-name"
    }
  }
}