英仕健康在线API系统

  • 附录(代码表)
  • 证件类型
  • 性别类型
  • 与投保人(被保人)关系
  • 交通类型
  • 承保地区
  • 接口状态代码表
  • 本保险业务接口文档是为渠道合作商(以下简称“渠道商”)应用系统提供承保、 出单、撤单、查询等业务功能。流程由渠道商应用系统发起请求,提交到本对接系统后,经处理后返回结果的方式。

    交互模式

    本业务对接系统采用HTTP协议封装数据,使用POST提交参数的方式与对接平台接口交互,POST请求的参数采用json格式封装数据,所有字段的取值应符合数据格式的具体要求。

    接口地址

    测试环境地址:http://test.inshealth.cc/api/+接口名称

    生产环境地址:对接时提供

    接口格式通用规则

    日期规则:所有日期以零时为单位。如保障期限为1天,则对应的起保日期为2016-01-01 00:00:00,则终保日期为2016-01-01 23:59:59。

    数据文件:采用标准的 json 格式,字符编码为 UTF-8;所有字段区分大小写。

    关于接口密钥的获取方式:

    签名 sign=md5(密钥+请求主体json),签名参数通过url传递,其余业务参数均以json格式post到服务器。

    示例调用:

    请求业务参数(具体报文格式见下一章节):{"transNo":"XXXXXXXX","deptCode":1000125, "data":null}

    提交的json字符串内容不应带有换行字符。

    密钥(由 本对接系统 分配):S3929ff2ssdf2idie3

    签名字符串signStr=S3929ff2ssdf2idie3{"transNo":"XXXXXXXX","deptCode":1000125, "data":null}

    签名结果sign=md5(signStr.getBytes("UTF-8")),假设md5之后的值为3828s2a916d71018cba3c242424fec51b,则最终请求地址为: http://test.inshealth.cc/api/savePolicy?sign=3828sea916d71018cb23c242424fec51b

    保单承保接口

    接口名: savePolicy

    渠道商提交投保内容。渠道商将客户的投保信息用json格式通过参数提交给本对接系统进行承保,本对接系统处理完成后将响应结果(成功/失败)返回给渠道商。

    请求
    字段 类型 必填 字段说明
    transNo
    String
    必填
    交易流水号
    deptCode
    String
    必填
    开发者身份标识,由本对接系统提供
    data
    JSON
    必填
    投保内容对象。
    policyInfo:投保单基本信息
    planCode
    String
    必填
    保险计划代码,由本对接系统提供
    startTime
    String
    必填
    起保时间,格式yyyy-MM-dd HH:mm:ss,若为整点则起保年月日内容为00:00:00
    endTime
    String
    必填
    终保时间,格式yyyy-MM-dd HH:mm:ss,若为整点则终保年月日内容为23:59:59
    createTime
    String
    必填
    创建时间,格式yyyy-MM-dd HH:mm:ss
    noType
    String
    非必填
    交通类型(产品为旅意险填写)
    noCode
    String
    非必填
    交通工具代码(产品为旅意险填写),如noType=1时,noCode为航班号
    travelFromAddress
    String
    必填
    出发地(产品为旅意险填写)
    travelToAddress
    String
    必填
    目的地(产品为旅意险填写)
    copiesCout
    Int
    必填
    投保份数,默认为1
    geographicalArea
    String
    必填
    承保地区(取值参考附录)
    notifyUrl
    String
    非必填
    保单信息异步回调地址
    chargeNum
    String
    非必填
    支付单号,来自支付接口返回
    medicalNum
    String
    非必填
    核保号,来自智能核保接口返回
    isRenewal
    String
    非必填
    是否续保,1:续保,0:非续保(默认)
    renewalPolicyNo
    String
    非必填
    续保单号,isRenewal=1时,必传
    holder:投保人信息
    appliType
    String
    非必填
    投保人类型:1-个人(默认),2-企业,团体,具体看产品支持
    name
    String
    必填
    投保人姓名
    sex
    String
    必填
    投保人性别(取值参考附录)
    birthday
    String
    必填
    投保人出生日期yyyy-MM-dd
    idType
    String
    必填
    投保人证件类型(取值参考附录)
    idNum
    String
    必填
    投保人证件号码
    mobile
    String
    必填
    投保人电话
    email
    String
    非必填
    投保人邮箱
    address
    String
    非必填
    投保人地址
    Insureds,被保人信息。类型为LIST对象,一个投保信息可由N个被保人结点组成,每个insured对象内容如下:
    Id
    Int
    必填
    被保人序号,内容为1,2,3序号
    name
    String
    必填
    被保人姓名
    sex
    String
    必填
    被保人性别(取值参考附录)
    birthday
    String
    必填
    被保人出生日期yyyy-MM-dd
    idType
    String
    必填
    被保人证件类型(取值参考附录)
    idNum
    String
    必填
    被保人证件号码
    mobile
    String
    必填
    被保人电话
    email
    String
    非必填
    被保人邮箱
    address
    String
    非必填
    被保人地址
    relaToInsured
    Int
    必填
    与投保人关系(取值参考附录)
    occupation
    String
    被保人对应的职业代码(取值参考附录)
    city
    String
    必填
    被保人城市代码,仅限一、二、三级城市
    siInd
    String
    必填
    0:无社保,1:有社保
    mainInsuredInd
    String
    必填
    1:主被保险人,2:连带被保险人
    premium
    Double
    必填
    被保人对应的保费
    occupationLevel
    String
    非必填
    职业类别(具体看产品)
    occupationDesc
    String
    非必填
    职业编码(具体看产品)
    beneficiaryList,受益人列表。(非必填)法定受益人不传递受益人信息,具体看产品,类型为List,每个beneficiary对象内容如下:
    beneficiaryGrade
    Integer
    必填
    受益人级别,组别(目前暂设:1)
    beneficiaryOrder
    Integer
    必填
    受益顺序
    beneficiaryType
    String
    必填
    受益人类型(0:生存受益人,1:身故受益人,2:除身故保险金以外的其他保险金受益人,3:满期受益人)
    interestPercent
    Double
    必填
    受益份额
    beneficiaryName
    String
    必填
    受益人姓名
    beneficiarySex
    String
    必填
    受益人性别(取值参考附录)
    beneficiaryBirthday
    String
    必填
    受益人生日yyyy-MM-dd
    beneficiaryIDType
    String
    必填
    受益人证件类型
    beneficiaryIDNo
    String
    必填
    受益人证件号码
    idExpDate
    String
    非必填
    证件有效期
    relationToInsured
    String
    必填
    受益人与被保人关系(取值参考附录)
    beneficiaryEmail
    String
    非必填
    受益人邮箱
    beneficiaryTelephone
    String
    非必填
    受益人电话
    beneficiaryZipCode
    String
    非必填
    受益人邮编
    beneficiaryAddress
    String
    非必填
    受益人联系地址
    响应
    字段 类型 字段说明
    returnCode
    Int
    返回代码,200为成功调用,其它为出错代码
    returnMsg
    String
    返回代码对应的中文解释
    transNo
    String
    与调用的transNo对应
    data: 投保返回的对象值
    orderNum
    String
    本对接系统成交的订单号
    results
    JSON
    由于一次请求可有N个投保人,每个投保人有一张保单,在result中为LIST子对象,用于显示每张保单号等信息
    id
    Int
    被保人序号
    policyNum
    String
    保单号,当保单号为ERROR为投保失败
    message
    String
    当policyNum为ERROR时,message将显示具体投保失败的原因

    投保示例: http://test.inshealth.cc/api/savePolicy?sign=3828sea916d71018cba3c242424fec51b

    请求内容:

         {
            "transNo":"LY201610010204020200545",
            "deptCode":"99990001",
            "data":{
                "policyInfo":{
                    "planCode":"1AN005001",
                    "startTime":"2018-02-28 00:00:00",
                    "endTime":"2018-03-01 23:59:59",
                    "createTime":"2018-01-16 23:42:21",
                    "noType":1,
                    "noCode":"MU3821",
                    "travelFromAdress":"广州",
                    "travelToAdress":"北京",
                    "copiesCout":"1",
                    "geographicalArea":"00001"
                },
                "holder":{
                    "name":"张文杰",
                    "sex":"M",
                    "birthday":"1981-08-31",
                    "idType":"I",
                    "idNum":"310107198108313017",
                    "mobile":"15388882521",
                    "email":"hello@inshealth.cn",
                    "address":"广州市先烈中路100号9栋508"
                },
                "insureds":[
                    {
                        "id":1,
                        "name":"吴林英10",
                        "sex":"F",
                        "birthday":"1985-10-13",
                        "idType":"I",
                        "idNum":"310107198510134922",
                        "mobile":"1762255219",
                        "email":"hello2@inshealth.cn",
                        "address":"广州市先烈中路100号9栋508",
                        "relaToInsured":"01",
                        "siInd":"0",
                        "mainInsuredInd":"1"
                    }
                ]
            }
        }

    响应内容:

         {
            "returnCode":200,
            "returnMsg":"",
            "transNo":"LY20161001020402020001",
            "data":{
                "orderNum":"ORD838382891",
                "results":[
                    {
                        "id":1,
                        "policyNum":"POL0398382"
                    }
                ]
            }
        }
    保单撤销接口

    接口名: cancelPolicy

    渠道商提交投保内容。渠道商将客户的投保信息用json格式通过参数提交给本对接系统进行撤销,本对接系统处理完成后将响应结果(成功/失败)返回给渠道商。

    请求
    字段 类型 必填 字段说明
    transNo
    String
    必填
    交易流水号
    deptCode
    String
    必填
    开发者身份标识,由本对接系统提供
    data
    JSON
    必填
    撤销内容对象。
    data,类型为LIST对象
    policyNum
    String
    必填
    保单号,撤销的保单号必须为有效且非生效状态
    响应
    字段 类型 字段说明
    returnCode
    Int
    返回代码,200为成功调用,其它为出错代码
    returnMsg
    String
    返回代码对应的中文解释
    transNo
    String
    与调用的transNo对应
    data: 撤销返回的对象值,类型为LIST对象
    policyNum
    String
    保单号
    status
    Int
    200:撤销成功,903:撤销失败
    message
    String
    当status=903时,message将显示撤单失败的原因

    撤销示例:http://test.inshealth.cc/api/cancelPolicy?sign=3828sea916d71018cba3c242424fec51b

    请求内容:

        {
            "transNo":"LY201610010204020200599",
            "deptCode":"99990001",
            "data":[
                {
                    "policyNum":"POL00001"
                },
                {
                    "policyNum":"POL00002"
                },
                {
                    "policyNum":"POL00003"
                },
                {
                    "policyNum":"POL00004"
                }
            ]
        } 

    响应内容:

        {
            "returnCode":200,
            "returnMsg":"",
            "transNo":"LY201610010204020200599",
            "data":[
                {
                    "policyNum":"POL00001",
                    "status":200,
                    "message":null
                },
                {
                    "policyNum":"POL00002",
                    "status":200,
                    "message":null
                },
                {
                    "policyNum":"POL00003",
                    "status":200,
                    "message":null
                },
                {
                    "policyNum":"POL00004",
                    "status":200,
                    "message":null
                }
            ]
        }
    在线保单PDF下载接口

    接口名: getPolicyPdf

    渠道商提交投保内容。渠道商将客户的投保信息用json格式通过参数提交给本对接系统进行pdf文件下载,本对接系统处理完成后将响应结果(成功/失败)返回给渠道商。

    请求
    字段 类型 必填 字段说明
    transNo
    String
    必填
    交易流水号
    deptCode
    String
    必填
    开发者身份标识,由本对接系统提供
    data
    JSON
    必填
    下载内容对象。
    data,类型为LIST对象
    policyNum
    String
    必填
    保单号,下载的保单号必须为有效状态
    响应
    字段 类型 字段说明
    returnCode
    Int
    返回代码,200为成功调用,其它为出错代码
    returnMsg
    String
    返回代码对应的中文解释
    transNo
    String
    与调用的transNo对应
    data: 撤销返回的对象值,类型为LIST对象
    policyNum
    String
    保单号
    status
    Int
    200:下载成功,其他:下载失败
    message
    String
    当status非200时,message将显示下载PDF失败的原因
    url
    String
    返回对应PDF的URL地址

    下载pdf示例: http://test.inshealth.cc/api/getPolicyPdf?sign=3828sea916d71018cba3c425254224fec51b

    请求内容:

        {
            "transNo":"LY20161001252244020200599",
            "deptCode":"99990001",
            "data":[
                {
                    "policyNum":"POL00001"
                }
            ]
        }

    响应内容:

        {
            "returnCode":200,
            "returnMsg":"",
            "transNo":" LY20161001252244020200599",
            "data":[
                {
                    "policyNum":"POL00001",
                    "status":200,
                    "message":null,
                    "url":"http://114.80.9.152:8088/pdf/POL0398382_38382892.pdf"
                }
            ]
        }
    证件类型
    值 说明
    I
    身份证
    P
    护照
    O
    其它
    性别类型
    值 说明
    M
    F
    与投保人关系
    值 说明
    01
    本人
    10
    配偶
    11
    丈夫
    12
    妻子
    20
    儿子
    30
    女儿
    40
    儿女
    50
    父母
    51
    父亲
    52
    母亲
    53
    继父
    54
    继母
    55
    叔伯
    56
    阿姨
    57
    兄弟
    58
    姐妹
    59
    外公
    60
    亲属
    62
    奶奶
    80
    单位
    81
    雇员
    82
    雇主
    99
    其他
    交通类型
    值 说明
    01
    航班号
    02
    车次
    03
    船次
    99
    其它
    承保地区
    值 说明
    00001
    中华人民共和国(不含港澳台地区)
    00002
    中华人民共和国(含港澳台地区)
    00004
    港澳台地区
    00010
    欧洲
    00050
    申根国家
    00054
    香港/澳门
    00055
    台湾
    00056
    东南亚
    00057
    全球
    接口状态代码表
    值 说明
    200
    调用成功
    900
    计划方案未找到
    901
    保单未找到
    902
    保单为无效状态
    903
    保单撤销失败
    904
    保单投保失败
    907
    保费计算不正确
    971
    渠道签名校验失败
    999
    其它错误