开发
API

课程库回调信息同步接口

介绍

该接口用于同步课程库回调信息,在添加/修改商品,上传商品资源,以及检测到不合规的商品后,会将结果回调通知到已同步的地址。

请求(request)

基本信息

HTTP URL

https://developer-product.zijieapi.com/product/api/sync_callback_url

HTTP Method

POST

请求头

参数名

参数类型

是否必须

备注

示例

Content-Type


string

请求的MIME类型,统一为application/json

"application/json"


请求体

参数名

参数类型

是否必须

备注

示例

access_token

string

接口调用凭证

"0801121846735352506a356a67395167574457583155554e67654321"

appid

string

小程序id

"tt12fd9846e1023401"

callback_url

string

接受通知的url

"https://callback.example.com"

developer_flag

string

确认通知方身份唯一标识

"21786419ahjeai1"

响应(response)

响应体

参数名

参数类型

备注

示例

err_no

number

错误码,0为成功

0

err_msg

string

错误内容

"success"

log_id

string

日志id,用于查询错误

"101210271802130982251451520919C123"

示例

请求
{
  "access_token": "123456184673546750597970442b6b73674775447154502f69413d3d",
  "appid": "123834792309",
  "callback_url": "https://callback.example.com",
  "developer_flag": "21786419ahjeai1"
}
响应
{
  "err_msg": "success",
  "err_no": 0,
  "log_id": "2021122721141201022513314212345678"
}

回调请求信息

该请求为回调通知请求格式,商品添加/修改,和商品资源接口返回的通知信息格式有差异。

HTTP URL

在同步回调接口中已同步的地址,例: https://callback.example.com

HTTP Method

POST

请求头

参数名

参数类型

备注

示例

Content-Type


string

请求的MIME类型,统一为application/json

"application/json"


请求体
商品上传,商品修改,商品下架(内部审核不通过)操作的通知信息

参数名

参数类型

备注

示例

produce_id

string

商品id

"1234abc"

produce_name

string

商品名称

"课程1"

produce_status

enum

商品状态

-1

produce_examine_res

bool

商品审核结果

false

reason

object

商品审核不通过原因


{

    "课程上传失败": [

          "课程收费不符合标准" ,

          "课程中存在违法信息" ,

     ]

}

notice_type

enum

通知类型

1

developer_flag

string

确定我方身份唯一的标志

"902398182034"

callback_data

string

自定义字段

"123qwr"

商品资源上传的通知信息

参数名

参数类型

备注

示例

resource_tos_uri

string

商品资源唯一

"product/resource/79436cc6fe83362149d"

produce_source_status

enum

商品资源状态

-1

produce_source_examine_res

bool

商品资源上传结果

false

reason

object

商品资源上传失败的原因


{

    "资源上传失败 ": [

          "资源中存在违法信息" ,

     ]

}

notice_type

enum

通知类型

4

developer_flag

string

我方身份唯一的标志

"902398182034"

callback_data

string

自定义字段

"123qwr"

教师和机构资质的认证与修改 操作的通知信息

参数名

参数类型

备注

示例

object_id

string

商品id

"T2343143214"

object_name

string

商品名称

"教师"

produce_status

enum

商品状态

-1

produce_examine_res

bool

商品审核结果

false

reason

object

商品审核不通过原因


{

    "课程上传失败": [

          "课程收费不符合标准" ,

          "课程中存在违法信息" ,

     ]

}

notice_type

enum

通知类型

1

developer_flag

string

确定我方身份唯一的标志

"902398182034"

callback_data

string

自定义字段

"123qwr"

响应(response)

返回的状态码必须为 200,其他状态码一律视为回调通知失败

参数说明

produce_status(商品状态)

商品状态

枚举值

已生效

1

未生效

-1

produce_examine_res(商品审核结果)

商品状态

bool值

审核通过

true

审核未通过

false

produce_source_status(商品资源状态)

商品资源状态

枚举值

已上传

1

未上传

-1

produce_source_examine_res(商品资源审核结果)

商品资源状态

bool值

审核通过

true

审核未通过

false

notice_type(通知类型)
课程库相关通知

通知类型

枚举值

课程入库通知

1

课程修改通知

2

课程下架通知(巡查不通过,监控不通过)

3

资源上传

4

资质审核相关通知

通知类型

枚举值

教师资质认证通知

11

教师资质修改修改通知

12

机构资质认证通知

13

机构资质修改通知

14

示例

商品上传通知请求
{
  "developer_flag": "1234abc",
  "notice_type": 1,
  "produce_examine_res": false,
  "produce_id": 1,
  "produce_name": "produce1",
  "produce_status": -1,
  "callback_data": "aabb1",
  "reason": {
    "商品上传失败": ["课程存在违法信息", "课程价格不合理"]
  }
}
商品修改(商品已生效)通知请求
{
  "developer_flag": "1234abc",
  "notice_type": 2,
  "produce_examine_res": false,
  "produce_id": 1,
  "produce_name": "produce1",
  "produce_status": 1,
  "callback_data": "aabb1",
  "reason": {
    "商品修改失败": ["课程存在违法信息", "课程价格不合理"]
  }
}
商品下架(内部审核不通过才通知)通知请求
{
  "developer_flag": "1234abc",
  "notice_type": 3,
  "produce_examine_res": false,
  "produce_id": 1,
  "produce_name": "produce1",
  "produce_status": -1,
  "callback_data": "aabb1",
  "reason": {
    "商品审核不通过": ["课程存在违法信息", "课程价格不合理"]
  }
}
商品资源通知请求
{
    "developer_flag":"123abc",
    "notice_type":4,
    "produce_source_examine_res":false,
    "produce_source_status":-1,
    "resource_tos_uri": "product/app1/source1"
    "callback_data":"aabb1",
    "reason":{
       "商品资源上传失败":[
           "资源存在违法信息",
       ]
    }
}
教师资质认证通知请求
{
  "developer_flag": "1234abc",
  "notice_type": 11,
  "produce_examine_res": false,
  "object_id": "T243252323423",
  "object_name": "老师",
  "produce_status": -1,
  "callback_data": "aabb1",
  "reason": {
    "教师资质认证失败": ["教师关键信息缺失"]
  }
}
点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助