共通仕様 #

全体 #

• リクエスト及びレスポンスのフォーマットはapplication/jsonとする

認証の事前設定 #

• 事前に利用事業者ごとのAPIキーおよびAPIキーシークレットが当社より通知される
• APIキーおよびAPIキーシークレットをパラメーターに設定してアクセストークン取得APIを使い、アクセストークンを取得する
• アクセストークンをHTTPヘッダX-LIQUID-AUTH-CONNECTOR-ACCESS-TOKEN に設定する
• アクセストークンの有効期限が切れた場合は、再度、アクセストークン取得APIを使い、アクセストークンを取得する

認証結果の確認 #

• 認証自体を行うAPIのレスポンスには認証結果は含まれず、認証結果は認証結果取得APIを使い別途取得する必要がある

エラーレスポンスフォーマット #

APIでエラーが発生した場合、レスポンスパラメーター errors にerrorオブジェクトが返却される

{
    "errors" : [
        {
          "code": "ERROR_CODE_1",
          "desc": "DESCRIPTION_FOR_DEVELOPPER",
          "value": "SOME_VALUE_ABOUT_ERROR"
        },
        {
          "code": "ERROR_CODE_2",
          "desc": "DESCRIPTION_FOR_DEVELOPPER",
          "value": "SOME_VALUE_ABOUT_ERROR"
        },
        ...
    ]
}

エラーコード一覧 #