kintoneから外部サービスのAPIを実行します。
このAPIを利用すると、クロスドメイン制約を回避して、外部APIにリクエストを送信できます。
外部にファイルをアップロードする際には、次のページを参照してください。
外部にファイルをアップロードする

PC／モバイル

kintone.proxy(url, method, headers, data, successCallback, failureCallback)

{
  "Content-Type": "application/json"
}

successCallbackを指定した場合、戻り値はありません。
引数のsuccessCallback以降を省略した場合、Promiseオブジェクトが返ります。
これにより、async/awaitを使って非同期処理を扱うことができます。

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

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

kintone.proxy(
  'https://api.example.com',
  'GET',
  {},
  {},
  (body, status, headers) => {
    // success
    console.log(status, body, headers);
  },
  (error) => {
    // error
    console.log(error); // proxy APIのレスポンスボディ(文字列)を表示
  }
);

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

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

try {
  const [body, status, headers] = await kintone.proxy(
    'https://api.example.com',
    'GET',
    {},
    {}
  );
  // success
  console.log(status, body, headers);
} catch (error) {
  // error
  console.log(error); // proxy APIのレスポンスボディ(文字列)を表示
}

• 存在しないサーバーをurlに指定した場合、ステータスコード「503」（DNS Cache Missing）のエラーが返ります。
• IPアドレス制限を設定している場合、このJavaScript APIを使って同一ドメインの別アプリに対しkintone REST APIを実行するには、kintoneのIPアドレスを許可してください。
  IPアドレスの詳細は、次のページを参照してください。
  cybozu.comが使用するドメインとIPアドレス
  ただし、外部APIを実行するAPIを通じてすべてのkintone環境から自由にアクセスできるようになるため、セキュリティの観点から推奨していません。
  同一ドメインに対するリクエストは、次のAPIを使用してください。
  kintone REST APIリクエストを送信するAPI
• このAPIを使って外部のAPIを実行しても、実行したAPI先で発行されるべきCookieは、自動で発行されません。
• HTTPメソッドにPOSTまたはPUTを指定した場合、「Content-Length」と「Transfer-Encoding」ヘッダーは自動で付加されます。
  リクエストするときに明示的に指定すると、エラーが発生します。
• 利用できる「Content-Type」に制限はありません。

• 実行する外部APIのレスポンスに関する制限は、次のとおりです。
  • レスポンスヘッダーの上限は、100行で、1行あたりの最大長は8,180bytesです。
  • レスポンスボディの上限は10MBです。上限を超えるとエラーになります。
  • レスポンスボディは文字列のみ対応しています。画像などのバイナリデータは取得できません。
• 自己証明書を使ったサーバーとの通信はできません。