药械系统数据接口说明.docx

1、北京市医用耗材阳光采购平台 -交易系统接口标准 医疗机构版 文档履历 文档编号 版本 修订说明 创建日期 生效 日期 备注 1.0 初稿 2018-06-26 2018-06-28 非正式文件 目录 1. 前言 . 3 2. 业务示范 . 3 3. 接口说明 . 5 3.1. 接口列表 . 5 3.2. H001 连通性测试 . 5 3.3. H002 获取接口调用凭据 . 6 3.4. H003 添加购物车 . 9 3.5. H004 获取收货信息 .13 4. 状态码 .17 4.1 状态码 .17 4.2 错误码 .18 5. 程序示例 .18 5.1 C#获取令牌 .18 5.2 JA

2、VA 示例代码 .18 1. 前言 该技术对接标准由 北京市医用耗材阳光采购平台 免费开放 给医疗机构 ，各医疗机构依据自身实际情况决定是否对接。如需对接，请仔细阅读该文档，如有疑问，可与我中心联系咨询。对接步骤如下： 2. 业务示范 1、 进行接口对接前 ， 医疗机构需从平台 （机构管理 交易设置页面） 处获得身份验证所需的账号 、 密码 等信息 。 2、 调用接口需要令牌进行身份验证，在通过调用接口 API 开展工作之前，需要先行调用 ” 获取接口调用凭证 ” 接口，获取令牌。 3、 因 北京市医用耗材阳光采购平台 基础数据与 医疗机构 内部系统基础数据不一致 ，医疗机构 需 从 北京市医

3、用耗材阳光采购平台 获取数据进行数据对照。 4、 医疗机构通过 ” 获取 订单 信息 ” 接口获取 本院在采购平台制定的订单。 5、 医疗机构通过 ” 获取 收货 信息 ” 接口获取 本院在采购平台 收货 的 信息 。 3. 接口说明 3.1. 接口列表 编号 接口名称 每日访问次数 H001 连通性测试 无限次 。 H002 获取接口调用凭据 10 次 /天。 H003 获取采购订单 10000 次 /天。 H004 获取入库明细 10000 次 /天。 3.2. H001 连通性测试 正式 URL： 正式网址 /v1/testConnection 测试 URL： 测试网址 /v1/test

4、Connection HTTP 请求方式： GET 重点提示：请复制该地址至浏览器进行访问，确定网络是否通畅。 返回值 调用结果 返回内容 备注 成功 “returnCode“:“1“, “returnMsg“:“OK“ JSON 格式。 失败 “returnCode“:“错误码 “, “returnMsg“:“错误原因 “ 错误码详见错误码字典。 3.3. H002 获取接口调用凭据 应用场景：通过医疗机构账号，密码进行获取通用凭据，后续获取采购订单、获取收货信息接口均需传入凭据。 正式 URL： 正式网址 /v1/hospitalInterface/accessToken/getToken

5、 测试 URL： 测试网址 /v1/hospitalInterface/accessToken/getToken HTTP 请求方式： POST 重点提示：医疗机构使用该接口时，需要将获得的平台时间【 currentTime】与医疗机构内部时间比对。确保时间一致。以减少不必要的问题。 备注：令牌有效期为 30min。且令牌效果类似 Session 滑劢，即最后一次访问后，如果 30min 内没有再次使用该令牌访问，则令牌失效。 在接口实际开发中 ，基本可以确定半小时内肯定有接口请求。那么此情境下令牌实际只需要获取一次令牌即可保证一直有效。各医疗机构开发时，应控制令牌请求次数不超过 10 次 /

6、天。 参数说明 参数名 类型 说明 是否必须 RequestData String 请求内容需进行 URL(utf-8)编码。请求内容 JSON 格式。 示例： “HospialID“:“医院编号 “, “Sceret“:“医院密码 “ R DataSign String 数据内容签名：把 (请求内容 (未编码 )+AppKey)进行 MD5 加密 最后进行 URL(utf-8)编码。详细过程请查看 Demo 示例 。 R 备注： R-必填（ Required）， O-可选（ Optional）， C-报文中该参数在一定条件下可选（ Conditional）。 返回值 调用结果 返回内容 备注

7、 成功 “returnCode“:“1“,备注： 1 表示成功，非 1 表示失败 。 “returnMsg“:“OK“,备注： 交互返回信息。 “accessToken“:“接口调用凭据 “,备注：返回令牌，后续以该令牌进行交互。 “expiresIn“:1800,备注：令牌有效期。 “currentTime“:“当前时间 “备注：当前服务器时间。 JSON 格式。 失败 “returnCode“:“错误码 “,备注： 错误码详见错误码字典。 “returnMsg“:“错误原因描述 “,备注： 业务执行描述 “accessToke“:“,备注：当前令牌为空。 错误码详见错误码字典。 “expi

8、resIn“:“备注：当前服务器时间。 3.4. H003 添加购物车 正式 URL： 正式网址 /v1/ hospitalInterface /shopping/add 测试 URL： 测试网址 /v1/ hospitalInterface /shopping/add HTTP 请求方式： POST 输入参数 参数名 类型 说明 是否必须 AccessToken String 传入 H002 返回的令牌 R RequestData String 请求内容需进行 URL(utf-8)编码。请求内容 JSON 格式。 示例： “orderData“: “hospitalOrderDetailID

9、“:“院内细单编号 ,varchar(36)“, R “goodsID“:“产品编号 , varchar(36)“, “purchaseCount“:“采购数量 ,int“, “purchasePrice“:“采购价格 ,decimal(18,2)“, “supplyID“:“供应商编号 ,varchar(36)“, “supplyName“:“供应商名称 ,varchar(256)“, “ReceiptMan“:“收货人 ,varchar(36)“, “ReceiptTel“:“收货人 电话 ,varchar(50)“, “ReceiptAddress“:“收货 地址 ,varchar(50

10、0)“ , “hospitalOrderDetailID“:“院内细单编号 ,varchar(36)“, “goodsID“:“产品编号 , varchar(36)“, “purchaseCount“:“采购数量 ,int“, “purchasePrice“:“采购价格 ,decimal(18,2)“, “supplyID“:“供应商编号 ,varchar(36)“, “supplyName“:“供应商名称 ,varchar(256)“, “ReceiptMan“:“收货人 ,varchar(36)“, “ReceiptTel“:“收货人 电话 ,varchar(50)“, “ReceiptAddress“:“收货 地址 ,varchar(500)“