配置API

  • Published by Viedoc System 2023-03-07
  • Print

访问API配置功能

要访问API配置功能并在Viedoc Admin中管理研究的API客户端，您需要为该研究设定API经理的用户角色。

API客户端ID

当需要使用API连接或者需要与研究相关的API终端交互时，您需要一个API客户端ID。客户端ID的使用方法如下：

  • 对于Viedoc WCF API，客户端ID与Viedoc用户名和密码一起使用，用于授权用户。
  • 对于Viedoc Web API，客户端ID和客户端保密被用于授权。无需用户内容。

为了确保与以前的Viedoc版本的向后兼容性，您可以在创建API客户ID时选择需要使用的数据结构版本。

添加一个Viedoc WCF API客户端并获得API客户端ID

如需添加一个API客户端并获得客户端ID，则：

1 在Viedoc登陆页面，点击Admin图标，打开Viedoc Admin。
2

打开所需使用的研究，点击API配置字段的编辑按钮，打开API配置对话框。

注意！您需要有API经理的用户角色才可查看API配置字段。
3

在WCF API客户端标签上，点击添加一个新的API客户端。
4

为API客户端输入一个名称，并在状态下拉菜单中选择该客户端是否应与正式或演示研究相链接。点击添加。
5

生成一个客户端ID，并显示在WCF API客户端的列表中（1）。
6 从数据结构版本下拉菜单中选择您希望数据结构兼容的版本(2)。您可以在任何时候编辑客户的状态，从状态下拉菜单中选择一个新的状态（正式、无操作或演示）。
7 记下客户端的ID，以便以后使用。

添加Viedoc Web API客户端并获得API客户端ID

如需添加一个Viedoc Web API客户端并获得API客户端ID，则：

1 在Viedoc登陆页面，点击Admin图标，打开Viedoc Admin。
2

打开所需使用的研究报告，点击API配置字段的编辑按钮，打开API配置对话框。

注意！您需要有API经理的用户角色才可查看API配置字段。
3

在Web API客户端标签上，点击添加一个新的Web API客户端。
4

为API客户端输入一个名称。
5 选择一个您希望数据结构兼容的数据结构版本。
6

在状态下拉菜单中选择客户端是否应该链接到正式或演示研究。您可以在任何时候通过从状态下拉菜单中选择一个新的状态（正式、无操作或演示）来编辑客户端的状态。

注意！如需为PMS研究配置API，您可以选择数据管理者下拉菜单，选择申办方或临床人员来缩小范围。
7

为用户选择一个适用的范围。适用的范围是:

  • 导出
  • 创建/更新中心
  • 获取中心信息
  • 邀请Clinic用户-要求客户端状态为正式
  • 邀请Admin用户-要求客户端状态为正式
  • 管理合同
  • 获取用户信息
8 可以选择输入允许访问Web API客户端的IP地址。您还可以通过分号隔开，以输入多个IP地址。
9 默认情况下，客户端保密过期时间提前1年。如果需要，可以设置其他日期，但不能超过当前日期的一年。
10 点击Add API客户端。
11

添加API客户端完成后，界面显示如下字段:

  • 客户端保密-提示! 确保您已经进行复制，因为该保密内容只显示一次。如果需要，您可以重新生成。
  • 客户端ID
  • 令牌URL
  • 授予类型
  • API URL
12 请记录稍后要使用的客户端ID。
13 如果需要，您可以更改范围、状态和数据结构版本的设置。
14 点击保存变更。

API客户端ID的数据结构版本号

在创建API客户端ID时，您需要选择要使用的数据结构版本。您可以选择的Viedoc版本只能是那些导入了数据结构更改的版本。

在Viedoc 4.68，以下数据结构版本是可用的:

数据结构版本 数据结构变更
最近版本 当选择最新的Viedoc版本时，Viedoc API交流通过的数据结构将自动遵循最新的Viedoc版本的结构，其中数据结构的变化已经被导入。
Viedoc 4.68 引入pdf档案导出系统检查，将档案分割成每位受试者的一个PDF文件，并将生成的PDF存储在一个压缩文件中。
Viedoc 4.67 新增医疗编码审批两列: “核准人”和 “核准日期”。
Viedoc 4.51 引入三个新的表单重复键和pdf导出的目录，详见下表。
Viedoc 4.39 引入重复表单和重复访视，详见下表。
Viedoc 4.38 原始输出格式（Viedoc 4.38版或更早的版本）。

在Viedoc 4.51中，对导出输出做了以下修改：

文件类型 导出输出格式的变更
Excel

为引入的新表单序列号增加了三列:

  • SubjectFormatFormSeqNo - 在受试者级别上唯一标识特定表单实例的计数器，即，从1开始，每次在为该受试者创建一个新的表单实例时递增。
  • OriginSubjectFormSeqNo - 被复制的表单实例，它标识数据第一次复制的表单实例。对于表单的第一个实例（即未复制），它获取SubjectFormSeqNo的值。
  • SourceSubjectFormSeqNo - 被复制的表单实例，一个计数器，用于识别被复制的表单实例的来源（数据被复制的表单实例）。它获取值为表单实例被复制的 SubjectFormSeqNo值。对于第一个表单实例（即未复制），显示为空值。
ODM 引入了三个新的表单序列号，作为Viedoc的扩展名：v4:SubjectFormSeqNo, v4:OriginSubjectFormSeqNo,和 v4: SourceSubjectFormSeqNo,在FormData中，紧随FormRepeatKey之后。
PDF 从文件的第2页开始，为PDF档案中新增目录。

在 Viedoc 4.39中，对导出输出格式做了如下变更：

文件类型

 导出输出格式的变更
Excel 增加一个包含FormRepeatKey的表单序列号（FormSeq）列。
ODM FormRepeatKey现在也包含了活动ID，格式如下：
FormRepeatKey$ActivityId。ExportVersion属性已被添加到ODM中。
PDF 摘要格式用于显示访视和表单名称。