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

PC／モバイル

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

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

successCallback を指定した場合、戻り値はありません。
引数の successCallback を省略した場合、 kintone.Promise オブジェクト が返ります。

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

1
2
3
4
5
6
7

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

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

1
2
3
4
5
6
7
8

try {
  const resp = await kintone.proxy('https://api.example.com', 'GET', {}, {});
  // success
  console.log(resp);
} catch (error) {
  // error
  console.log(error);
}

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

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