[Share] 知行EDI系统Admin API

知行EDI系统的内置API提供了一种灵活的管理应用程序的方法。用户在管理控制台界面中可以完成的一切也可以通过调用RESTful API(应用编程接口)来完成。

Admin API由API Resource和API Action组成,API可以调用Resource和Action,以管理来自外部脚本、服务器和应用程序:

  • 检索应用程序工作流中的文件
  • 检索关于应用程序处理的文件的元数据或日志数据
  • 将文件插入应用程序工作流进行处理
  • 更新连接器或个人配置页面中的配置信息
  • 触发连接器的发送/接收功能

Admin API支持JSON格式的OData作为默认的REST协议,支持的其他网络服务格式还包括OData(Atom), SOAP, HTML和CSV。

API Browser

“Resource”和“Action”部分中包含API中可用的Resource和Action的概述,关于每个Resource和Action的更多信息都可以在应用编程接口浏览器中找到。

要访问应用程序的API Browser,请从应用程序界面右上角的“API”下拉菜单中选择“Admin API”选项:

edi-admin-api

API Browser包括每个Resource和Action的可用属性,以及使用API的代码示例(JQuery和cURL)。

请注意,标记为必需的一些“ID”属性可以通过其他属性的组合来指定。例如,如果文件由“ConnectorId”、“Folder”和“Filename”组合标识,则不需要文件资源的“MessageId”属性来获取特定文件。同样,如果提前不知道Log资源(Log, Transaction和Request)的标识,也可以省略。

Authentication

用户通过应用程序中生成的授权令牌(Auth Token)获得访问API的权限。授权用户和相关授权令牌(Auth Tokens)的列表位于管理控制台的“安全性”选项卡下的“配置文件”页面中。

要生成新的用户/令牌组合,请单击“+添加”按钮,并指定允许该用户使用的HTTP方法(GET、POST、PUT/MERGE/PATCH、DELETE)。

授权令牌(Auth Token)可以通过几种方式在API请求中使用:

  • 在HTTP请求中包含x-arcesb-authtoken标头,并将该值设置为用户的授权令牌(Auth Token)
  • 将用户和身份验证令牌作为用户名/密码组合来进行HTTP基本身份验证(HTTP Basic Authentication)
  • 将授权令牌(Auth Token)作为查询参数包含在请求网址中

要在请求URL中包含授权令牌,必须启用AllowAuthTokenInURL设置。该选项位于“安全性”选项卡中经过身份验证的API用户的表格下方。启用后,身份验证令牌查询参数的语法如下:‘@authtoken=myAuthTokenValue’

Resource

Resource是API中公开的对象,可以查询、创建、更新和删除。这些Resource包括:

  • 文件-检索应用程序工作流中的文件,或将文件推入应用程序工作流(通过将它们添加到连接器的输入文件夹中)
  • 证书-检索或更新用于加密、签名、解密、验证、SSL/TLS等的数字证书。
  • 连接器-检索或更新现有连接器的配置,或将新连接器添加到应用程序工作流中
  • 事务-从事务日志中检索元数据,记录成功和失败的文件传输(发送和接收)。
  • 日志-从记录应用程序级错误的应用程序日志中检索日志数据
  • 配置文件-检索或更新应用程序本地配置文件的配置
  • 请求-从记录HTTP请求的访问日志中检索日志数据

每个资源都遵循以下规则在专用的应用程序端公开:/api.rsc/resourceName。例如,如果知行EDI系统托管在“mydomain.com”上且端口为8001,则以下端点将用于访问File Resource:

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

更多Resource详细资料,请参考应用程序界面右上角的“API”下拉菜单中选择“Admin API”选项中内容。

Action

API操作扩展了可以在资源上执行的操作集,也可以执行与特定资源无关的操作。操作总是通过超文本传输协议调用的。

每个操作都在专用的应用程序端点公开,使用以下约定:/api.rsc/actionName。例如,如果ArcESB托管在“mydomain.com”上并侦听端口8001,则以下端点将用于访问归档日志操作:

POST http://mydomain.com:8001/api.rsc/archiveLogs

动作的参数是在超文本传输协议帖子的JSON格式的正文中指定的。请求必须包含适当的内容类型标题(例如应用程序/json),以便正确解释POST正文。应用程序用户界面中的应用程序接口浏览器详细介绍了每个操作的可用参数。

管理应用编程接口包括以下操作:

  • 归档日志-将日志数据从应用程序数据库移动到磁盘上的归档文件中。
  • 复制连接器-使用现有连接器配置创建新的ArcESB连接器
  • 创建证书-为加密、签名、解密、验证、SSL/TLS等创建新的数字证书(公钥/私钥对)。
  • 删除日志-从应用程序数据库中删除日志数据
  • 删除事务-从事务日志中删除日志数据
  • 下载文件-指示指定的连接器下载/接收指定的文件(或基于连接器配置的所有适用文件)
  • 交换证书-更新连接器的数字证书
  • 获取事务日志-检索特定事务的详细事务日志数据
  • 导入配置文件-将配置文件设置、连接器设置或工作区设置从压缩配置归档文件添加到ArcESB
  • 刷新事务-为指定连接器重建事务缓存,以确保事务日志数据是最新的
  • 重启文件-重启连接器发送的文件的传出传输
  • 发送文件-指示连接器处理(上传、发送、转换等)连接器输入文件夹中的文件。
了解更多,请您电话 150-0298-3180 / 177-8250-8152 或邮件 edi@kasoftware.cn 联系我们,获取 30 天全功能 免费试用 版本。
标签: , , ,
文章分类 ansi x12, as2, as3, edi 电子数据交换, edifact, EDI实施案例, mft 管理文件传输, odette, oftp(2.0), RosettaNet, share 知识分享, vda, 动态, 示例工程