外部API的执行

bxzhang发表于:2016年09月13日 13:45:36更新于:2017年08月03日 16:46:50

Index

执行外部的API

从kintone可以执行外部的API。
当把文件上传到外部时,请参照 “将文件上传到外部” 。

  • PC端和智能手机端都可以使用。

  • 即使通过proxy,也不能自动发行需在proxy端的网站发行的cookie。

函数

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

参数

参数名称要指定的值必須说明
url字符串
必須请求URL
method字符串
必須HTTP方法。 GET,POST,PUT,DELETE 中任一个。
headers对象必須指定请求头对象。
未指定的时候,默认{}。
(例) {'Content-Type': 'application/json'}
data对象或字符串必須请求里包含的数据。未指定的时候,默认{}。
仅在POST/PUT情形下被使用,GET/DELETE 情形下被无视。
在GET/DELETE的情况下、需要往URL的QueryString里传递参数。
callback函数
可省略

向Proxy处发送的请求,结束时执行的回调函数。
参数里赋值的是来自proxy的response body (字符串)、status code(数字)、response header(对象)。
省略的情况下,默认返回kintone.Promise对象,里面是含有response body (字符串)、status code(数字)、response header(对象)信息的数组。

errback函数
可省略

发往proxy API 的请求,失败时执行的回调函数。
接受来自proxy的参数:response body (字符串)。
callback省略的情况下,默认返回kintone.Promise对象,在proxy API的response body (字符串)里含有出错信息。

返回值

省略参数callback时,返回 kintone.Promise 对象。
参考: 事件处理的写法

指定callback的时候,没有返回值。

 

例子

使用call back的记述方法


使用kintone.Promise的记述方法

注意事项

  • 当用url指定不存在的服务器的情形,应答为包含状态代码 “503”(DNS Cache Missing)的错误。

  • 测试环境之类等对IP有限制的环境里,访问链接源域名里的其他应用时,可以访问以下页面里许可的IP地址。

关于kintone 常有的提问(仅支持日文):
http://faq.cybozu.info/alphascope/cybozu/web/kintone/Detail.aspx?id=60

※ 但是如果使用kintone.proxy的话,可自由访问外部的链接,从安全性上来说并不推荐。请大家使用kintone.api来访问链接源的域名。

限制事项

  • 从proxy 返回的response header的上限为 100行,每一行最大长度为 8192bytes。

  • 从proxy 返回的response body的上限为 10MB。

  • 超过上限会产生错误。

将文件上传到外部

从kintone可以将文件上传至外部。

  • PC端和手机端都可以使用。

  • 即使通过proxy,也不能自动发行需在proxy端的网站发行的cookie。

函数

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

参数

参数名称要指定的值必须
说明
url字符串必須请求URL
method字符串必須HTTP方法。 POST,PUT中任一个。
headers对象
必須指定请求头对象。
未指定的时候,默认{}。
(例) {'Content-Type': 'application/json'}
data对象必須请求里包含的数据。
{
    'format': 向 proxy 上传数据时使用的格式,
    'value': 上传的数据
}
format 是字符串、只能指定 "RAW"。
value 是Blob型 (包括 File型) 的值。value的大小最多为 200MB。
callback函数
可省略

向Proxy处发送的请求,结束时执行的回调函数。
参数里赋值的是来自proxy的response body (字符串)、status code(数字)、response header(对象)。
省略的情况下,默认返回kintone.Promise对象,里面是含有response body (字符串)、status code(数字)、response header(对象)信息的数组。

errback函数
可省略

发往proxy API 的请求,失败时执行的回调函数。
接受来自proxy的参数:response body (字符串)。
callback省略的情况下,默认返回kintone.Promise对象,在proxy API的response body (字符串)里含有出错信息。

返回值

省略参数callback时,返回 kintone.Promise 对象。
参考: 事件处理的写法

指定callback的时候,没有返回值。 

例子

使用call back的记述方法


使用kintone.Promise的记述方法

注意事項

  • 当用url指定不存在的服务器的情形,应答为包含状态代码 “503”(DNS Cache Missing)的错误。

限制事项

  • 从proxy 返回的response header的上限为 100行,每一行最大长度为 8192bytes。

  • 从proxy 返回的response body的上限为 10MB。

  • 超过上限会产生错误。

  • 目标浏览器为Internet Explorer11、最新的Firefox、最新的Chrome、最新的Safari、最新的iOS Safari、最新的Android Chrome。

相关技巧


    您需要登录后才可以回复