Class:AppPot.Gateway

Gateway APIにアクセスするためのクラスです。

Class Methods

get(serviceName, url, params, body, options) -> Promise

Gateway APIのGET Methodを呼び出します。

引数:

Name	Type	Description
serviceName	String	AppPot管理コンソールで設定した、サービスの名前を指定します。
url	String	任意のURLのPATHを指定できます。呼び出し先に連携されます。
params	Object	URL末尾に付加する、クエリパラメータ {key: value} の形式のオブジェクトか、文字列が指定できる。使用しない場合はnullを指定します。
body	Object	requestbodyに指定するデータを指定します。使用しない場合はnullを指定します。
options	GatewayOptions	API呼び出しオプションです。

Return:

Type: Promise

Example

const AppPot = AppPotSDK.getService(config);
AppPot.Gateway.get(serviceName, url, queryparam, body, option)
  .then((response) => {
     ...
  });

post(serviceName, url, params, body, options) -> Promise

Gateway APIのPOST Methodを呼び出します。

引数:

Name	Type	Description
serviceName	String	AppPot管理コンソールで設定した、サービスの名前を指定します。
url	String	任意のURLのPATHを指定できます。呼び出し先に連携されます。
params	Object	URL末尾に付加する、クエリパラメータ {key: value} の形式のオブジェクトか、文字列が指定できる。使用しない場合はnullを指定します。
body	Object	requestbodyに指定するデータを指定します。使用しない場合はnullを指定します。
options	GatewayOptions	API呼び出しオプションです。

Return:

Type: Promise

Example

const AppPot = AppPotSDK.getService(config);
AppPot.Gateway.post(serviceName, url, queryparam, body, option)
  .then((response) => {
     ...
  });

put(serviceName, url, params, body, options) -> Promise

Gateway APIのPUT Methodを呼び出します。

引数:

Name	Type	Description
serviceName	String	AppPot管理コンソールで設定した、サービスの名前を指定します。
url	String	任意のURLのPATHを指定できます。呼び出し先に連携されます。
params	Object	URL末尾に付加する、クエリパラメータ {key: value} の形式のオブジェクトか、文字列が指定できる。使用しない場合はnullを指定します。
body	Object	requestbodyに指定するデータを指定します。使用しない場合はnullを指定します。
options	GatewayOptions	API呼び出しオプションです。

Return:

Type: Promise

Example

const AppPot = AppPotSDK.getService(config);
AppPot.Gateway.put(serviceName, url, queryparam, body, option)
  .then((response) => {
     ...
  });

remove(serviceName, url, params, body, options) -> Promise

Gateway APIのDELETE Methodを呼び出します。

引数:

Name	Type	Description
serviceName	String	AppPot管理コンソールで設定した、サービスの名前を指定します。
url	String	任意のURLのPATHを指定できます。呼び出し先に連携されます。
params	Object	URL末尾に付加する、クエリパラメータ {key: value} の形式のオブジェクトか、文字列が指定できる。使用しない場合はnullを指定します。
body	Object	requestbodyに指定するデータを指定します。使用しない場合はnullを指定します。
options	GatewayOptions	API呼び出しオプションです。

Return:

Type: Promise

Example

const AppPot = AppPotSDK.getService(config);
AppPot.Gateway.remove(serviceName, url, queryparam, body, option)
  .then((response) => {
     ...
  });

Interface

GatewayOptions

Name	Type	Description
original	Boolean	連携先サービスのレスポンスをそのまま受け取るかどうかを指定します。 true を指定すると、{error: {error時の返答}, response: {ajaxのレスポンス}} という形式でレスポンスを受け取れます。 false の場合、レスポンスのbodyをjsonとして解釈したオブジェクトを受け取ります。
headers	Object	リクエストヘッダ