Upload a file to outside of Kintone from a plug-in.
If your external REST API requires sensitive information such as secret keys, use the Set Config for proxy() API and Get Config for proxy() API to save and get these data for the external REST API.

kintone.plugin.app.proxy.upload(pluginId, url, method, headers, data, successCallback, failureCallback)

A kintone.Promise object will be returned if the successCallback or failureCallback parameters are ignored. Otherwise, nothing will be returned.

This method can be used in the following pages:

Desktop pages:

• Record List
• Record Details
• Record Create
• Record Edit
• Record Print
• Graph
• File Import
• File Export

Mobile pages:

• Record List
• Record Details
• Record Create
• Record Edit

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

var data = {
  'format': 'RAW',
  'value': '<some blob object>'
};

kintone.plugin.app.proxy.upload('mjjfipoklghomcgafnajfibfgllhpocm', 'https://api.example.com', 'POST', {}, data, function(body, status, headers) {
  // success
  console.log(status, JSON.parse(body), headers);
}, function(error) {
  console.log(error); // Display the response body (string) from the proxy API
});

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

var data = {
  'format': 'RAW',
  'value': '<some blob object>'
};

kintone.plugin.app.proxy.upload('mjjfipoklghomcgafnajfibfgllhpocm', 'https://api.example.com', 'POST', {}, data).then(function(args) {
  // success
  /*  args[0] -> body(String)
     *  args[1] -> status(Number)
     *  args[2] -> headers(Object)
     */
  console.log(args[1], JSON.parse(args[0]), args[2]);
}, function(error) {
  console.log(error); // Display the response body (string) from the proxy API
});

• Specifying a non-existent url will return an error status code of 503 (DNS Cache Missing).
• If the request origin subdomain has IP restrictions and attempts to access another App in the same subdomain, the kintone.com IP Addresses must be allowed access. A list of IP Addresses used by Kintone can be found in the following article on the help site:
  Domains and IP Addresses Used by Kintone
• Note that this allows any kintone.com domain to access the API. Therefore, it is not recommended from a security standpoint.
• When using this API to execute external APIs, cookies that should be generated at the API destination are not automatically generated.
• The Content-Length header and Transfer-Encoding headers are automatically added if the HTTP Method is set to POST or PUT. Explicitly setting when making requests will cause an error.

• The following are the limitations on external API responses to be executed:
  • The maximum lines of the response header from the other end of the proxy is 100 lines, and the maximum size for each line is 8,180 bytes.
  • The maximum size of the response body from the other end of the proxy is 10MB. Errors will occur if lines or sizes go over the maximum.
  • This API can only handle a response body of characters. Images, or other binary data are not supported.
• Communication with servers using self-signed certificates is not possible.
• Compatible browsers can be found on the following link:
  Kintone System Requirements

The request header that will be sent is the contents of the request header specified in the Kintone Plug-in Proxy plus the saved plug-in data that was saved with setProxyConfig().

Example:
If {k1: 'v1'} was specified in the request header for setProxyConfig(), and {k2: 'v2'} was specified in the request header for Kintone Plug-in Proxy, the request header will become {k1: 'v1', k2: 'v2'} .

When the HTTP method is POST/PUT, the data sent will depend on the data format.
If the data format is an object, the data specified in the Kintone Plug-in Proxy plus the saved plug-in data that was saved with setProxyConfig() will be sent.
If the data format is a string, only the data specified in the Kintone Plug-in Proxy will be sent.

When the HTTP method is GET/DELETE, the plug-in data saved with setProxyConfig() will be added as a Query String to the end of the specified url parameter of the Kintone Plug-in Proxy.
If "?" is not included in the specified url parameter, this will also be added.

Example:
If {k1: 'v1', k2: 'v2'} was specified in the data for setProxyConfig(), and 'https://api.github.com?k=v' was specified in the url for Kintone Plug-in Proxy, the url will become 'https://api.github.com?k=v&k1=v1&k2=v2'

If setProxyConfig() is used to save two different settings that use the same named keys, the settings with the URL that most matches the URL specified in the Kintone Plug-in Proxy will take priority.

Example:
If setProxyConfig() is used to save two different settings as below,

1
2

url: 'https://api.github.com'
headers:  {k1: 'v1', k2: 'v2'}

and

1
2

url: 'https://api.github.com/'
headers: {k2: 'v2-1', k3: 'v3'}

then, if the Kintone Plug-in Proxy is used with the url as 'https://api.github.com/' , the request header will become

1

{k1: 'v1', k2: 'v2-1', k3: 'v3'}

As explained in the parameter descriptions in the table for the setProxyConfig(), if the keys in the saved settings use the same named keys as the ones in the Kintone Plug-in Proxy, the saved keys will take priority.
If the HTTP method is GET/DELETE, the overlapping of keys is not checked.

Example:
If setProxyConfig() is used to save settings as below,

1

headers: {k1: 'v1', k2: 'v2'}

and Kintone Plug-in Proxy is used with

1

headers: {k2: 'v2-1', k3: 'v3'}

then in this case, both headers contain the k2 value, but the saved settings will take priority, thus the request header will become

1

{k1: 'v1', k2: 'v2', k3: 'v3'}