测试文档(产品帮助文档专用)

我的资源

1. 我的API服务

我的API服务页面,展示当前用户有权限调用的所有API服务,包括两类来源:

* 用户从资源/接口/产品门户申请且审批通过的API服务

* 管理员授权给当前用户的API服务

列表上显示接口名称、接口编号、接口类型、调用方式、申请数量、服务余量、服务可用状态。

备注:

1. 同一接口(相同接口编号)的多条申请/授权记录,合并为一行展示,申请数量和服务余量均做汇总累加

2. 服务可用状态:包括正常、不可用、冻结。余量用完、接口已下架等情况均显示为“不可用”;管理员在【服务授权管理】中执行冻结操作后,状态显示为“冻结”。


操作按钮说明:

【调用】:点击【调用】后,页面展示该接口的完整文档,具体调用方法请参考下一章节《使用API服务》。

【查看申请】:点击后打开申请详情弹框,若同一接口申请过多次,弹框中列表展示每次申请的时间、申请数量等信息

2. 使用API服务

从【我的API服务】页面找到目标接口,点击【调用】打开接口文档。参照文档,使用第三方工具(如Postman)调用接口的步骤如下:

步骤一:获取API密钥

首次使用需要先获取密钥。若已获取过,可跳过本步骤,直接查看密钥。

在接口文档页面,点击接口地址旁边的【查看密钥】

若尚未创建密钥,页面显示EDG-APPKEY和EDG-APPSECRET为空,点击【立即前往】跳转至【个人设置 → API密钥】页面;也可直接前往该页面

在【个人设置 → API密钥】,点击【获取密钥】,系统自动生成并显示您的:EDG-APPKEY(申请者ID)和EDG-APPSECRET(申请者密钥)

请妥善保管密钥,不要泄露给他人。

步骤二:获取访问令牌(Token)

接口文档中会说明该接口的【令牌获取方式】。调用任何业务接口前,需先调用获取令牌接口,拿到有效token。

获取令牌接口地址:/edataservice/token/gettoken.do?EDG-APPKEY={实际APPKEY}&EDG-APPSECRET={实际APPSECRET}

调用时,将 {实际APPKEY} 和 {实际APPSECRET} 替换为步骤一中获取的真实值,并去掉花括号。

使用Postman调用示例:

1.请求方式:GET/POST

2.输入完整地址(替换真实APPKEY和APPSECRET)

3.点击【Send】

返回的token参数值即为后续调用业务接口所需的令牌(token)


token有效期说明:

1.默认有效期为2小时

2.如需调整,可由管理员登录系统,进入【系统管理 → 用户权限 →秘钥管理】页面修改令牌有效时长。请注意:修改后仅对新生成的token生效,已生成的旧token仍按原有效期计算

 

步骤三:调用业务接口

以【员工基本信息1】接口为例:

参照接口文档,确定请求方式、请求地址和请求体格式

在Postman中:

1.输入接口地址,例如:/edataservice/api/YGJBXX1

2.在 Headers 中添加参数:EDAPI-TOKEN,传步骤二中获取的token值(如:3be1d74c89374f668a44338200c244c6)

3. 在 Body 中按文档提供的请求示例填写请求体

4.点击【Send】发送请求

调用成功:接口正常返回数据

常见失败原因:

token已过期:需重新调用步骤二获取新token

未添加EDAPI-TOKEN请求头:请检查Headers配置

3. 我申请的API服务

展示当前用户已提交的所有API服务申请记录,便于跟踪审批进度和管理已有申请。审批通过后的记录,会同步至【我的API服务】页面进行调用。

列表展示接口名称、接口编号、申请时间、申请方式、申请数量、审批状态、审批人、审批时间、审批意见等信息。

 

操作按钮说明:

【申请详情】:所有审批状态的记录,都可以点击查看申请详情,新页签展示申请时的详细信息

【撤回申请】:仅待审批状态的记录可以点击撤回申请,点击后记录状态变为“已撤回”。撤回后如需继续使用,可点击【重新申请】

【重新申请】:审批通过、已退回、已撤回状态的记录都可以点击重新申请,打开申请调用框,用户可填写申请信息后提交。

逻辑说明:若当前状态为已退回或已撤回,重新申请是更新已有记录,状态变回“待审批”;若当前状态为审批通过,重新申请是新增一条记录,新申请的额度追加到原服务余量中

 

备注:记录仅在终止流程时才会被删除,常规操作(撤回、退回等)不会删除记录

附件列表

0

文档内容仅供参考
如果您需要解决具体问题,还可以登录亿信社区
在提问求助板块提问,30分钟内帮您解决问题

如果您认为本词条还有待完善,请编辑

上一篇数据服务及概览

下一篇服务预警

请先登录