方软OpenApi-机构版
    方软OpenApi-机构版
    • 接口变更记录
    • 开发前准备
    • 请求签名鉴权方式
    • OAuth2.0鉴权方式
    • 常见问题速查
    • 接入
      • 获取AccessToken
        GET
      • 刷新AccessToken
        GET
    • 公共数据获取
      • 三大目录(药品/收费项目/材料)
        • 查询三大目录
        • 查询三大目录(分页版)
        • 启用停用收费项目
        • 保存物资材料信息
        • 查询三大目录营销特性
      • 部门
        • 同步部门信息
        • 同步业务相关部门
      • 字典
        • 同步字典
        • 同步开发渠道
      • 员工
        • 同步员工信息
        • 根据岗位同步员工信息
        • 保存员工档案
      • 合作单位
        • 同步合约单位
        • 同步供应商
        • 同步生产商
      • 同步机构信息
        GET
      • 执行sql脚本获取数据
        POST
    • 系统管理接口
      • 三方应用免密登录
        • 获取登录用户信息
        • 获取frtoken
      • 文件管理
        • 文件下载
        • 文件上传
        • 根据key获取资源
      • 消息推送
        • 消息推送
        • 患者信息推送
        • 患者会员等级变动消息
        • 单据删除消息推送
        • 门诊结账
        • 门诊退费
        • 保存三方聊天记录
        • 批量保存三天聊天记录
        • 门诊挂号
      • 系统用户相关(认证鉴权)
        • 用户登录接口
        • 校验用户密码、校验用户身份
        • 三方用户绑定
        • 获取三方用户信息
      • 三方自定义消息通知
        POST
      • 给员工发送通知消息
        POST
      • 自定义字段修改
        POST
    • 患者档案相关
      • 检查患者是否存在
        GET
      • 查患者信息
        GET
      • 患者信息推送测试
        GET
      • 查询患者列表
        GET
      • 获取患者标签
        GET
      • 给患者打标签
        POST
      • 患者建档
        POST
      • 更新患者信息
        PUT
      • 关键字查询客户列表
        GET
      • 集团客户机构建档
        POST
      • 查询患者家庭成员
        GET
      • 绑定患者家庭成员
        POST
      • 取消绑定患者家庭成员
        DELETE
      • 查询患者附件
        GET
      • 保存患者附件
        POST
    • CRM
      • 预约
        • 获取预约列表
        • 获取预约详情
        • 患者预约
        • 取消预约
      • 网络预约
        • 患者网络预约申请
        • 取消网络预约
      • 回访
        • 查询指定客户回访列表
        • 客户回访
        • 作废回访
      • 网电咨询
        • 新增患者咨询
        • 查询指定患者的咨询记录
      • 排班
        • 获取排班班次
        • 获取值班数据
    • 会员
      • 优惠券
        • 获取会员已领取优惠券列表
        • 给会员赠送优惠券
        • 作废优惠券
      • 卡项
        • 获取患者持有卡项(已购卡记录)
        • 获取持有卡项项目
        • 获取卡项使用记录
      • 客户积分操作
      • 客户项目剩余
      • 获取会员账户信息
      • 会员充值
      • 会员账户变动记录
      • 更改会员类别/会员等级
    • HIS
      • 门诊
        • 门诊挂号
          • 获取门诊挂号类别字典
          • 门诊挂号收费接口
        • 门诊结算
          • 获取患者未结账门诊收费单
          • 门诊费用明细记录查询
          • 门诊收银结算
          • 门诊退费
        • 分诊登记接口
        • 分诊登记撤销
        • 门诊登记记录
        • 新增门诊收费单
        • 作废门诊收费单
      • RIS
        • 检查申请单登记
        • 检查申请单撤销
        • 检查报告单
        • 申请单查看
        • 报告单的保存
        • 确认费用
        • 查询检验结果
        • 查询单个检验结果明细
      • 客户照片
        • 创建照片订单
        • 上传照片(照片内容base64编码)
        • 上传照片
        • 获取患者照片列表
      • 财务
        • 应收账款
          • 获取患者的欠费单据
          • 患者还款
        • 客户消费明细
      • 病历
        • 获取患者门诊病历
      • 排队叫号
        • 患者排队叫号列表
        • 患者回诊排队
      • 项目划扣
        • 划扣接单
        • 开始执行
        • 执行完成
        • 撤销项目划扣
        • 请领
        • 客户项目执行记录
        • 房间项目执行情况
    • 外加工
      • 外加工消息通知
    • 进销存
      • 保存采购进货单
      • 作废库房单据
      • 审核库房单据
      • 根据进货单生成出库单
    • OA审批
      • 获取审批单状态
      • 获取审批单列表
      • 保存折扣申请审批单
      • 驳回申请单
    • 渠道管理
      • 查询渠道
      • 保存渠道
      • 批量保存渠道
    • 三方平台
      • 微信公众号

    开发前准备

    一、配置应用信息#


    1.
    请前往 方软医疗平台 > 后台管理 > 接口参数设置 > 选择“方软开放平台接口”。
    2.
    参数分为【基础参数】和【权限参数】,主要填写基础参数的“三方应用名称”、“应用id”、“访问秘钥”。

    二、异常代码#

    代码名称
    10000环境初始化错误
    10001Token校验不通过
    10002Token失效或过期
    10003请求头错误
    10004黑名单拦截
    10005当前请求接口未授权
    20001环境初始化错误
    20002签名值过期
    20003签名校验不通过

    三、参数解释#

    2.1 基础参数#

    三方应用名称:第三方应用的名称。
    应用ID:用于识别请求时是哪个应用。
    访问密钥:用于请求接口时交换令牌的密钥。
    IP白名单:配置不需要验证Token的IP,逗号分割。格式:如192.168.1.88,192.168.1.xx。
    IP黑名单:配置禁止访问的IP,英文逗号分割。格式如上。
    消息推送:是否开启消息推送,默认不开启。
    推送地址:消息推送地址。需要填写完整路径,如:http://frhis.com/api

    2.2 权限参数#

    访问授权控制:开启后接口访问将根据下方参数判断有没有授权。
    公共数据获取:获取系统基础数据,包含以下授权接口:
    1.
    用户字典
    2.
    三大目录
    3.
    部门信息
    4.
    员工信息
    5.
    岗位员工信息
    患者信息: 对患者的基本操作和查询,包含以下授权接口:
    1.
    查询用户是否存在
    2.
    查询患者信息
    3.
    查询客户列表
    4.
    查询客户标签
    5.
    患者建档
    6.
    更新患者信息
    CRM:包含以下授权接口:
    1.
    获取排班班次
    2.
    获取值班数据
    3.
    患者预约
    4.
    取消预约
    5.
    患者网络预约
    6.
    取消网络预约
    会员:包含以下授权接口:
    1.
    客户积分操作
    2.
    客户消费记录
    3.
    客户购买项目(设计中)
    财务:包含以下授权接口:
    1.
    客户消费记录明细表
    上一页
    接口变更记录
    下一页
    请求签名鉴权方式
    Built with