获取购买e签宝套餐链接

更新时间:2022-11-23 11:05:46

接口描述

用于获取免登录购买e签宝套餐的页面链接。

注意事项:

  • 【生态合作伙伴专用】注册成为e签宝的生态伙伴,即可通过本接口来获取购买e签宝套餐页面链接。

(在对接此接口前,请提供您的应用AppId及所属环境给e签宝的交付人员或商务经理协助配置。)

  • 操作购买的经办人须确保已加入企业组织下,点击前往“企业成员服务API”添加成员。
  • 生态伙伴可以自行推送此链接或集成到自身业务系统中,以便企业经办人员进行购买e签宝套餐操作。
  • 通过此链接购买成功后,生态伙伴可查阅购买套餐回调通知接收说明来获取套餐购买信息。

接口地址&请求方法

接口地址:https://{host}/v3/orders/org-place-order-url

请求方法:POST

请求头格式

具体请求头参数,请查看公共请求头格式

请求参数

参数名称

参数类型

必选

参数位置

参数说明

orgId

string

body

机构账号ID(购买方orgId)

transactorPsnId

string

body

经办人个人账号ID(购买操作个人psnId)

redirectUrl

string

body

重定向地址,用于设置套餐购买后页面的跳转。

  • 重定向地址需是以http或https开头的互联网可访问的链接。
  • 购买后,用户点击【返回】按钮时触发页面跳转。

notifyUrl

string

body

回调通知地址,购买完成后发送回调通知给该地址

customBizNum

string

body

自定义业务编号(用于关联开发者的业务系统)

【注】:接口不对该参数的值做重复性校验。

响应参数

展开全部参数参数名称

参数类型

必选

参数说明(左右拖动查看完整描述)

code

int32

业务码,0表示成功,非0表示异常。

message

string

业务信息

请根据 code 来判断错误情况,不应该依赖message 匹配,因为 message 可能会调整。

data(点击“+”展开详情)

object

业务数据


orgPlaceOrderUrl

string

购买套餐页面Url (有效期60分钟)

请求示例

{
    "orgId": "0c5bd4924**648bfbf",
    "transactorPsnId": "c7e0029472914**10541e7",    
    "redirectUrl": "https://www.xxx.com",
    "notifyUrl": "http://xx.xx.xx.172:8081/CSTNotify/asyn/notify",
    "customBizNum": "这是一串开发者内部系统自定义的编号"
}

响应示例

{
    "code":0,
    "message":"成功",
    "data":{
        "orgPlaceOrderUrl":"https://openapi.esign.cn/auth/guide?loginId=xx-xx-xx-xx-xxx"
    }
}
我要纠错