kintone APIドキュメント

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

目次

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

固定リンクがコピーされました

次の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でheadersに指定したリクエストヘッダー
プラグインから外部APIを実行するAPI
data オブジェクト 次のAPIでdataに指定したリクエストボディ
外部APIの実行に必要な情報をプラグインへ保存するAPI
nullになる条件

利用できる画面

固定リンクがコピーされました

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

サンプルコード

固定リンクがコピーされました

このAPIを使って、次の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);

注意事項

固定リンクがコピーされました

  • このAPIを使って、次のAPIでheaderに指定した値を取得する場合、必ず値は文字列になります。
    外部APIの実行に必要な情報をプラグインへ保存するAPI
    たとえば、headersに数値型や真偽値型の値を設定したとします。

    1
2
3
4
5

    const headers = {
  key1: 1, // 数値
  key2: true, // 真偽値
};
kintone.plugin.app.setProxyConfig('https://api.example.com', 'POST', headers, {}, () => console.log('Saved!'));

    このとき、次のAPIを実行すると、数値型や真偽値型の値は、文字列型で返ります。
    外部APIの実行に必要な情報を取得するAPI

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

    const config = kintone.plugin.app.getProxyConfig('https://api.example.com', 'POST');
console.log(config);
/**
 * 1とtrueは文字列型になる
 * {
 *    headers: {
 *      "key1": "1", // 文字列
 *      "key2": "true",  // 文字列
 *    },
 *    data: {},
 *  }
 **/