号卡分销接入规范2

编写	octopus_lpg	编写时间	2024-03
	V1.0
当前版本	V1.0

修订历史

序号	变更内容	版本号	版本日期
1	初稿	v1.0	2024-03-29

注意事项

• 接口接入方式采用标准 https/http+json 协议，通过 get/post 方式调用服务

• 调用接口前，需提前联系运营人员获取 octopusAuthCode 需设置在请求 header 中

• 接口地址： act.occrab.cn/openapi/fenxiao/gth

• 接口有频次限制，如服务器请求请提前联系运营人员，设置IP白名单

• 测试 octopusAuthCode : 37e632b03b818c37e28b0d10b36edb4d

1. 请求header 示例

curl -H 'octopusAuthCode: 1a2b3c4d' -H 'version: v1.0'

2. 表单提交

基本信息

请求方式	post
uri	/addOrder

Body请求示例

{
  "slotId":"6520", 
  "name":"testname",
  "phone":"18212341234",
  "certNo": "xxxxxxx",
  "province": "北京",
  "city": "北京市",
  "district": "西城区",
  "address": "xxxxxxxx"
}

请求参数

序号	名称	位置	类型	必选	说明
	octopusAuthCode	header	string	是	授权码
	version	header	string	是	固定值：v1.0
	body	body	object	是

| 1 | slotId | body | string | 是 | 渠道编号，来源由章鱼运营人员分配 | | 2 | name | body | string | 是 | 姓名 | | 3 | phone | body | string | 是 | 联系方式 | | 4 | certNo | body | string | 是 | 身份证号 | | 5 | province | body | string | 是 | 省份名称| | 6 | city | body | string | 是 | 城市名称| | 7 | district | body | string | 是 | 地区名称| | 8 | address | body | string | 是 | 详细地址 |

成功示例

{
  "code" : 200,
  "message"  : "成功",
  "data" : [
    "uuid":"表单编号"
  ]
}

失败示例

{
  "code" : 50001,
  "message"  : "订单提交失败",// 或替他失败描述
  "data": {"msg":{"code":51304,"info":"1234, 该产品不存在"}}// 详细描述信息
}

其他状态请参照返回值说明

3. 订单信息接口

基本信息

请求方式	get
uri	/getInfo

Body请求示例

{
  "uuid":""
}

请求参数

序号	名称	位置	类型	必选	说明
	octopusAuthCode	header	string	是	授权码
	version	header	string	是	固定值：v1.0
	body	body	object	是
1	uuid	body	string	是	订单编号，来源表单提交

成功示例

{
    "code": 200,
    "message": "成功",
    "data": {
        {
          "outer_id":"asdf",//订单编号
          "plan_mobile_produced":"订阅手机号",
          "status":"订单状态", // 
          "is_activated":"是否激活",// 
          "activated_at":"激活时间",
          "is_recharged":"是否首充",// 1 已首充
          "recharged_at":"首充时间",
          "tracking_number":"物流单号",
          "tracking_company":"物流公司名称",
          "reason":"失败原因"
        }
    }
}

返回内容说明

序号	名称	类型	说明
	code	string	状态码
	message	string	信息说明
	data	object
1	outer_id	string	订单编号
2	plan_mobile_produced	string	订阅手机号
3	status	string	订单状态,0:订单终止,550:已发货,-120:信息审核失败,-460:开卡失败等如没有状态对应信息请联系章鱼运营人员
4	is_activated	string	是否激活,1:已激活,0:未激活,100:已激活,200:激活且充值
5	activated_at	string	激活时间
6	is_recharged	string	是否首充
7	recharged_at	string	首充时间
8	tracking_number	string	物流单号
9	tracking_company	string	物流公司名称
10	reason	string	失败原因

其他状态请参照返回值说明

返回值说明

code	说明(message)
200	成功
-	-
40301	请求频率受限
-	-
40400	未授权
40401	版本不能为空
40402	相关参数不能为空
40403	没有可选的手机号
40404	找不到可用的套餐信息
40405	该地址无法配送
40406	身份校验失败
40407	不存在的订单信息
40408	取消状态类型错误
-	-
50001	订单提交失败
50200	请重新提交
-	-
50401	地区信息获取失败
50402	该订单状态不允许取消
50403	取消订单失败