外部APIの実行

Garoon から外部のAPIを実行できます。

関数

garoon.base.proxy.send(proxyCode, url, method, headers, data, callback, error)

引数

^*1 garoon.Promiseオブジェクトは、thenメソッドを持っているオブジェクトです。
   ▼参考(外部サイト)https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Promise

返り値

引数のcallbackを省略した場合、garoon.Promiseオブジェクトを返します。

callbackを指定した場合返り値はありません（undefinedが返ります）。

実行できる画面

ポップアップ画面を除く全ての画面で利用できます。

サンプルコード

コールバックを使った記述方法

garoon.Promiseオブジェクトを使った記述方法

外部APIにリクエストが送られる条件

関数「garoon.base.proxy.send()」を使用した次の条件をすべて満たすリクエストが送られます。

• proxyCodeパラメータがプロキシAPIの設定画面の「プロキシコード」と同一であること
• methodパラメータがプロキシAPIの設定画面の「メソッド」と同一であること
• urlパラメータがプロキシAPIの設定画面の「URL」と前方一致すること^*2 

• ^*2 URLの前方一致について
  たとえば、次のようにURLを指定した場合には、URLが前方一致します。

  • プロキシAPIの設定画面の「URL」
    https://api.example.com/
  • garoon.base.proxy.send()のurlパラメータ
    https://api.example.com/operate.json

外部API実行時に送信されるデータ

パラメータ

• プロキシAPIの設定画面で設定された「パラメーター」はgaroon.base.proxy.send()で指定されたurlパラメータに付加されます。
• プロキシAPIの設定画面に「パラメーター」が設定されており、garoon.base.proxy.send()で指定されたurlパラメータにQueryStringの開始を表す '?' が含まれていない場合は合わせて付加します。

例）次のようにパラメータを指定した場合

• プロキシAPIの設定画面の「パラメーター」
  • キー: k1, 値: v1
  • キー: k2, 値: v2
  • キー: k3, 値: v3
• garoon.base.proxy.send()のURL
  • 'https://api.github.com?k2=v2' 

例）次のようにリクエストヘッダを指定した場合

• プロキシAPIの設定画面の「ヘッダー」
  • キー: k1, 値: v1
  • キー: k2, 値: v2
• garoon.base.proxy.send()のリクエストヘッダ
  • {k2: 'v2'} 

ボディ

• 以下の表は、メソッド/Content-Type/garoon.base.proxy.send()で指定されたフォーマット毎に送られるリクエストデータの仕様と例をまとめたものです。

重複キーの処理（ヘッダ、ボディ）

• プロキシAPIの設定画面で同一のキーがある場合、前者の値を優先します。

         例）次のようにヘッダを指定した場合

• •  プロキシAPIの設定画面の「ヘッダー」
    • キー: k1, 値: v1
    • キー: k1, 値: v1-priority

         →外部API実行時のヘッダは{k1: 'v1-priority'}となります。

• garoon.base.proxy.send()で設定されたキーとプロキシAPIの設定画面で設定されたキーが同一の場合、プロキシAPIの設定画面を優先します。

         例）次のようにヘッダを指定した場合

• •  プロキシAPIの設定画面の「ヘッダー」
    • キー: k1, 値: v1
    • キー: k2, 値: v2-setting
  • garoon.base.proxy.send()のリクエストヘッダ
    • {k2: 'v2'}

         →外部API実行時のヘッダは{k1:'v1', k2: 'v2-setting'}となります。