[Share] API 资源

总览

资源是在系统 API中公开的对象,可以查询,创建,更新和删除。 这些资源包括:

  • Files – 检索知行之桥工作流程中的文件,或将文件推送到知行之桥工作流程中(将它们添加到端口的输入文件夹中)
  • Certificates – 检索或更新用于加密,签名,解密,验证,SSL / TLS等的数字证书
  • Connectors – 检索或更新现有端口的配置,或向知行之桥工作流添加新的端口
  • Transactions – 从事务日志中检索元数据,记录成功和失败的文件传输(发送和接收)
  • Logs – 从知行之桥日志中检索日志数据,知行之桥日志中记录了应用程序级错误
  • Profile – 检索或更新知行之桥本地配置文件的配置
  • Requests – 从访问日志中检索记录HTTP请求的日志数据

可在以下知行之桥接口处公开访问每个资源: /api.rsc/resourceName. 例如,如果知行之桥托管在”mydomain.com”上并在侦听端口8001,则以下接口可以访问Files Resource:

xml
http://mydomain.com:8001/api.rsc/files

资源访问方法

本节介绍用于访问系统 API公开的资源的HTTP方法。

GET

HTTP GET请求可用于从知行之桥检索资源或资源集。 GET请求可以返回多行,也可以仅返回单行,具体取决于请求中是否指定了查询参数。

不带参数的 GET 请求

不包含查询参数的GET请求将返回该Resource类型的所有实例。 例如,如果对 Certificates 资源进行了不带查询参数的GET请求,则响应将包括知行之桥中保存的每个证书; 与 Connectors 资源类似的请求将返回知行之桥工作流中每个已配置端口实例的配置数据。

不带参数的GET请求的目标URL应与资源接口相同:

xml
GET http://mydomain.com:8001/api.rsc/certificates

带参数的 GET 请求

GET请求可以在目标URL中包含查询参数,可以将结果集限制为目标资源的单个实例。 例如,对 Files 资源的GET请求可以包括特定的端口,Folder和Filename参数,以检索由该端口处理的某个文件。 查询参数在目标URL末尾的括号中指定,例如:

xml
GET http://mydomain.com:8001/api.rsc/files(connectorId='myConnector',Folder='Receive',Filename='myFile.txt')?@authtoken=myAuthTokenValue

知行之桥用户界面内的API浏览器中详细介绍了每种资源的可用参数。

POST

HTTP POST请求可用于在知行之桥中创建指定资源的新实例。 例如,向 Files 资源发出POST请求会将一个文件插入到知行之桥的工作流中,向 Connectors 资源发出POST请求将在工作流中创建一个新配置的端口。

新资源的参数以JSON格式作为POST的正文提供。 该请求必须包含适当的内容类型头部 (比如 application/json) ,以便正确解释POST正文。知行之桥用户界面内的API浏览器中详细介绍了每种资源的可用属性。 以下是 Connectors 资源的示例POST正文:

json
{
"ConnectorId":"myNewConnector",
"ConnectorType":"Zip",
"Workspace":"Default",
}

connectors 资源还根据指定的ConnectorType值支持其他属性。 通过在JSON正文中加入字段名称和值,可以在POST调用期间设置任何可配置的端口字段。 例如,当创建一个新的Zip端口时,该端口的“ Operation”字段可以设置为 Decompress:

json
{
"ConnectorId":"myNewConnector",
"ConnectorType":"Zip",
"Workspace":"Default",
"Operation":"Decompress"
}

POST请求的目标URL应与资源接口相同:

xml
POST http://mydomain.com:8001/api.rsc/connectors

PUT

HTTP PUT请求可用于更新知行之桥中指定资源的实例。 例如,向 Connectors 资源发出PUT请求将更新知行之桥工作流中某个已配置端口的设置。

PUT请求需要目标URL中的查询参数和PUT的JSON正文中的属性的组合。 URL中的查询参数确定要更新资源的哪个实例(例如,要更新哪个端口),而JSON属性确定该资源中要更新的字段(例如,应将哪个端口配置字段设置为新值)。

查询参数在目标URL末尾的括号中指定,例如:

xml
PUT http://mydomain.com:8001/api.rsc/connectors(ConnectorId='myZipConnector')

请求的JSON正文包括针对目标资源实例进行更新的特定资源的字段。 该请求必须包含适当的内容类型头部(例如application/json),才能正确解释PUT主体。

以下是用于更新Zip端口实例的“ Operation”字段的PUT请求的JSON主体示例:

json
{
"Operation":"Compress"
}

DELETE

HTTP DELETE请求可用于从知行之桥中删除指定资源的实例。 例如,对 Files 资源发出DELETE请求将从知行之桥工作流程中删除一个文件。

DELETE请求需要在目标URL中加入查询参数,以标识要删除的资源的实例。 查询参数在目标URL末尾的括号中指定,例如:

xml
DELETE http://mydomain.com:8001/api.rsc/files(connectorId='myConnector',Folder='Send',Filename='myfile.txt')

知行之桥用户界面内的API浏览器中详细介绍了每种资源的可用参数。

前往知行软件官网主页,了解更多。

了解更多EDI,请您电话 150-0298-3180 / 177-8250-8152 或邮件 edi@kasoftware.cn 联系我们,获取 30 天全功能 免费试用 版本EDI软件。
标签: , , , , ,
文章分类 share 知识分享, 动态