外部APIの実行に必要な情報をプラグインへ保存する

目次

外部APIの実行に必要な情報をプラグインへ保存する

外部のAPIを実行するときに必要な情報を、プラグインに保存します。
このAPIを使って保存された情報は、 プラグインから外部APIを実行するAPIを実行したときに、リクエストのヘッダーとボディに追加されます。

認証情報など、秘匿する情報を外部APIの実行で使用する場合は、このAPIを使って必要な情報をあらかじめプラグインに保存します。

このAPIは、アプリの管理者だけがアクセスできるプラグイン設定画面でのみ実行できます。
そのため、アプリの利用者がプラグインへ保存された情報にアクセスすることを防げます。

関数

PC

kintone.plugin.app.setProxyConfig(url, method, headers, data, successCallback)

引数

指定したURLとHTTPメソッドの組み合わせがすでに存在している場合は、プラグインの設定が上書きされます。

引数 必須 説明
url 文字列 必須 実行するAPIのURL
method 文字列 必須 HTTPメソッド
次のいずれかの値を指定します。
  • GET
  • POST
  • PUT
  • DELETE
headers オブジェクト 必須 APIのリクエストヘッダーに加えるパラメーター
指定したパラメーターが、 プラグインから外部APIを実行するAPIで指定したパラメーターと重複する場合、このAPIで指定したパラメーターが優先されます。
何も指定しない場合は、空のオブジェクトを指定します。
data オブジェクト 必須 APIのリクエストデータに加えるリクエストボディ
例:
{
"key1": "value1",
"key2": "value2"
}
指定したキーが、 プラグインから外部APIを実行するAPIで指定したボディのキーと重複する場合、このAPIで指定したプロパティの値が優先されます。
何も指定しない場合は、空のオブジェクトを指定します。
プロパティの値にオブジェクト形式の値を指定できません。
successCallback 関数 省略可 外部APIのリクエスト情報の保存が完了したときに実行されるコールバック関数
引数はありません。
successCallbackを省略する、または「undefined」か 「null」を指定している場合、アプリ設定のプラグインの一覧画面に遷移し、設定完了メッセージを表示します。
successCallbackを指定すると、アプリ設定のプラグインの一覧画面には遷移しません。

戻り値

なし

利用できる画面

PC
  • 各プラグインの設定画面
モバイル

なし

補足

保存した情報がリクエストに追加される条件
  • プラグインから外部APIを実行するAPIを使ったリクエストでは、次の条件をすべて満たすときに、プラグインへ保存した情報がリクエストに追加されます。

    • アプリが同一
    • プラグインが同一
    • HTTPメソッドが同一
    • 実行するAPIのURLが前方一致する *1
      URLの大文字と小文字は区別されます。
  • プラグインに複数の設定を保存した場合は、APIの実行時に指定したURLと、より多くの文字が一致するURLを指定している設定が優先されます。
    たとえば、このAPIで、次のようなURLやリクエストヘッダーを指定したとします。

    • 設定その1
      • URL:https://api.example.com/
      • ヘッダー:{ "Content-Type": "application/x-www-form-urlencoded" }
    • 設定その2
      • URL:https://api.example.com/foo/
      • ヘッダー:{ "Content-Type": "application/json" }

    次の値を指定して、 プラグインから外部APIを実行するAPIを実行します。

    • URL:「https://api.example.com/foo/operate.json」
    • ヘッダー:{}

    このとき、APIの実行時に送信されるリクエストのヘッダーは、{ "Content-Type": "application/json" }です。

*1

たとえば、それぞれの関数で次のURLを指定した場合には、URLが前方一致するため、プラグインへ保存した情報がリクエストに加わります。

^