kintone Proxy

kintone Proxykintone.proxy()

Runs an external API that lies outside of kintone.

Function

kintone.proxy(url, method, headers, data, callback, errback)

Parameters

PARAMETER VALUE REQUIRED DESCRIPTION
url String Yes The request URL.
method String Yes The HTTP method. Specify one of the following: GET / POST / PUT / DELETE.
headers Object Yes Specify the request header as an object. To ignore this parameter, input {}.
Sample: {'Content-Type': 'application/json'}
data Object or String Yes The data that will be sent in the request.To ignore this parameter, input {}.
Applied only for POST/PUT requests. Ignored for GET/DELETE requests.
For GET/DELETE requests, set the parameter on the QueryString of the URL instead.
callback Function Optional The callback function that will run once the request to the other end of the proxy has finished. It will receive the response body (string), the status code (number) and the response header (object) as parameters from the external API.

If ignored, a kintone.Promise object will be returned that can be fulfilled with an array containing a Response body (string), Status code (number) and Response header (object).
errback Function Optional The callback function that will run when the API request to the other end of the proxy fails. It will receive the response body (string) as the parameter from the external API.
If the callback is ignored, a kintone.Promise object will be returned that can be fulfilled with the Response body (string) from the proxy API.

Response

A kintone.Promise object will be returned if the callback parameter is ignored. Otherwise, there will be no response.

Sample Request

kintone.proxy('https://*****.***.net', 'GET', {}, {}, function(body, status, headers) {
    console.log(status, JSON.parse(body), headers);
}, function(error) {
    console.log(error);  //Display the response body (string) from the proxy API
});

Sample Request using Promises

kintone.proxy('https://*****.***.net', 'GET', {}, {}).then(function(args) {
    /*  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
});

Limitations

  • This API can be used on both Desktops and Smartphones.
  • This API cannot be initiated from apps attached to bodies of Spaces/Threads/Announcements.
  • The site on the other end of the proxy will not automatically issue cookies.
  • 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 8192 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.
Was this article helpful?
0 out of 0 found this helpful
Comments
Please sign in to leave a comment.