外部 API の実行に必要な情報を取得する

目次

外部 API の実行に必要な情報を取得する

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

関数

PC/モバイル

kintone.plugin.app.getProxyConfig(url, method)

引数

引数 必須 説明
url 文字列 必須 実行する API の URL
method 文字列 必須 HTTP メソッド
次のいずれかの値を指定します。
  • GET
  • POST
  • PUT
  • DELETE

戻り値

外部 API の実行に必要な情報が、キーと値を対にしたオブジェクトの形式で返ります。

パラメーター名 説明
headers オブジェクト プラグインから外部 API を実行する APIheaders に指定したリクエストヘッダー
data オブジェクト 外部 API の実行に必要な情報をプラグインへ保存する APIdata に指定したリクエストボディ
null になる条件

利用できる画面

  • プラグインごとの設定画面

サンプルコード

この API を使って、 外部 API の実行に必要な情報をプラグインへ保存する API で保存した値を取得する例です。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
const headers = {
  Authorization: 'Bearer TEST_TOKEN',
};
const data = {
  key1: '1',
  key2: true
};
kintone.plugin.app.setProxyConfig('https://api.example.com', 'POST', headers, data);
const config = kintone.plugin.app.getProxyConfig('https://api.example.com', 'POST');
console.log(config);

注意事項