开发
API

【泛知识】查询课程

接口介绍

该接口用于查询已添加和审核中的课程信息,单次查询不能超过 500 个课程

使用限制

接口说明

  • 业务场景

以课程 id 为维度查询课程信息

基本信息

HTTP URL

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

HTTP Method

POST

权限要求

请求头

名称

类型

是否必填

描述

Content-Type

string

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

请求参数

参数名

参数类型

是否必须

备注

示例

access_token

string

接口调用凭证

"0801121846735352506a356a67395167574457583155554e67654321"

appid

string

小程序id

"tt12fd9846e1023401"

product_ids

array

课程id列表

[5432181212227612345, 768781212227612345]

请求示例

{
  "access_token": "12345678467354704e4f556f66496b774337614d4239784e78513d3d",
  "appid": "tt77fd0140e89bba1234",
  "product_ids": [5432181212227612345, 768781212227612345]
}

响应参数

名称

类型

描述

示例值

err_no

number

错误码,0为成功

0

err_msg

string

错误内容

"success"

log_id

string

日志id,用于查询错误

"101210271802130982251451520919C123"

data

object

返回数据,课程信息列表,只返回有效的课程id对应的入库和进审课程信息

详见下方data参数详解

product_info--课程详情

product_on_shelf 指的是入库的课程,调用添加课程接口且成功过审一次后就会入库

如果只有在审核中的商品,则 product_on_shelf 为空

名称

类型

描述

示例值

product_on_shelf

object

已入库的课程

详见下方product参数

product_reviewing

object

最近一次进审的课程

详见下方product参数

product--课程信息

名称

类型

描述

示例值

product_id

number

课程id

1234564871002310293

product_type

enum

商品类型,1-课程

1

common_product_info

object

通用商品信息

详见下方common_product_info参数

course_info

object

课程特有信息,仅当课程类型为课程时有效

详见下方course_info参数

product_status

object

课程状态

详见下方product_status参数

common_product_info--通用课程信息

名称

类型

描述

示例值

product_id

number

课程id

1234564871002310293

product_type

enum

课程类型, 1-课程

1

appid

string

小程序appid

"tt12fd9846e1023401"

first_class

number

一级课程分类,详见这里

10000

second_class

number

二级课程分类,详见这里

10100

title

string

课程名称

"python入门教程"

qualification_urls

array[string]

课程资质存储url列表

["https://abc.def.com/product/resource/qualification1.jpg", "https://abc.def.com/product/resource/qualification2.jpg"]

purchase_precaution

string

购物须知

"购买后如何观看课程?

答:小程序内购买课程为课程兑换权益,购买成功后将自动兑换到您的账户内,可在****中重复学习观看。

购买后,是否可以永久观看?

答:可以,本课程为付费产品,购买成功后,即可永久性收看该课程。

观看后是否可以退款?

答:不可以/可以。"

product_fulfillment_lst

array

课程履约列表

[
  {
    "fulfillment_content": {
      "fulfillment_uri": "product/resource/0001d044d41140d53ce9e57d793a4321",
      "text": "",
      "name": "课程履约视频"
    },
    "fulfillment_type": 1
  },
  {
    "fulfillment_content": {
      "fulfillment_uri": "product/resource/1001d044d41140d53ce9e57d793a4321",
      "text": "",
      "name": "课程履约音频"
    },
    "fulfillment_type": 2
  },
  {
    "fulfillment_content": {
      "fulfillment_uri": "product/resource/2001d044d41140d53ce9e57d793a4321",
      "text": "",
      "name": "课程履约图片"
    },
    "fulfillment_type": 3
  }
]

industry_type

enum

行业类目, 1-泛知识

1

price_info

object

价格信息

{
    "unit" : "节",
    "price" : 1000,
    "real_price" : 800,
}

path_info_lst

array

路径信息列表,用于分发

[
  {
    "path": "page/index/index",
    "query": {
      "curriculum_id": "382648"
    }
  }
]

product_detail_lst

array

课程详情列表

[
  {
    "text": "1. python安装步骤",
    "img_uri": "product/resource/5001d044d41140d53ce9e57d793a4321"
  },
  {
    "rich_text": "1. python安装步骤"
  }
]

anchor_info

object

锚点信息

{
  "video_anchor_info": {
    "anchor_title": "python入门教程"
  }
}

product_fulfillment--履约内容

名称

类型

描述

示例值

fulfillment_content

object

履约详情,用户购买课程后能学习的内容

{
    "fulfillment_uri":"product/resource/0001d044d41140d53ce9e57d793a4321",
    "name": "课程履约视频"
}

fulfillment_type

enum

履约类型,枚举值,详见fulfillment_type枚举列表

3

fulfillment_content--履约详情

名称

类型

描述

示例值

fulfillment_uri

string

履约文件资源uri

"product/resource/0001d044d41140d53ce9e57d793a4321"

text

string

文字内容

"Python支持多种编程范型,包括函数式、指令式、反射式、结构化和面向对象编程。"

name

string

履约内容名称

"python入门到精通"

price_info--价格信息

名称

类型

描述

示例值

unit

string

价格粒度单位

price

number

优惠活动前的服务原始价格

5000

real_price

number

当前服务的实际成交价格

4900

range_min_price

number

当前服务的实际成交价格区间:最低价格

3000

range_max_price

number

当前服务的实际成交价格区间:最高价格

6000

path_info--路径信息

名称

类型

描述

示例值

path

string

课程商品详情页路径

"page/index/index"

query

map(string, string)

课程商品详情页路径query参数

{

 "curriculum_id": "4938274"

}

product_detail--商品详情

可以是文字,图片,图文或者富文本类型

名称

类型

描述

示例值

text

string

文字详情

"该节课程主要用于帮助****在***方面得到***的提升"

img_uri

string

图片详情

"product/resource/1001d044d41140d53ce9e57d793a4321"

rich_text

object

富文本详情,不转义








rich_text--商品详情富文本内容

名称

类型

描述

示例值

text

string

富文本字符串,不转义








anchor_info--锚点信息

名称

类型

描述

示例值

video_anchor_info

object

视频锚点信息,0 < anchor_title字符长度 <= 24字节,汉字占2个字符

{
    anchor_title: "示例锚点标题"
}

course_info--课程信息

名称

类型

描述

示例值

teacher_introduction

string

"华语知名唱片制作人"

老师介绍

product_status--课程状态

名称

类型

描述

示例值

status

enum

1

课程状态,枚举型

针对入库课程(product_onshelf):

1 - 上架,2 - 下架

针对审核中课程(product_reviewing):

1 - 审核中,2 - 审核通过,3 - 审核不通过

reject_reason

string

"图片不符合要求"

下架或审核不通过原因

响应示例

正常示例

{
  "err_msg": "success",
  "err_no": 0,
  "log_id": "202204271324260102252431250D04BCE0",
  "data": {
    "products": [
      {
        "product_on_shelf": {
          "common_product_info": {
            "anchor_info": {
              "video_anchor_info": {
                "anchor_title": "python入门指南"
              }
            },
            "appid": "tt77fd0140e89bba8401",
            "first_class": 30000,
            "industry_type": 1,
            "path_info_lst": [
              {
                "path": "page/index/index",
                "query": {
                  "curriculum_id": "10348594"
                }
              }
            ],
            "price_info": {
              "price": 5000,
              "real_price": 4900,
              "unit": "节"
            },
            "product_detail_lst": [
              {
                "img_uri": "product/resource/f515d1e894139856877b9a31877e6887",
                "text": "课程详情"
              }
            ],
            "product_fulfillment_lst": [
              {
                "fulfillment_content": {
                  "fulfillment_uri": "product/resource/0001d044d41140d53ce9e57d793a4321",
                  "text": "",
                  "name": "课程履约视频"
                },
                "fulfillment_type": 1
              },
              {
                "fulfillment_content": {
                  "fulfillment_uri": "product/resource/1001d044d41140d53ce9e57d793a4321",
                  "text": "",
                  "name": "课程履约音频"
                },
                "fulfillment_type": 2
              },
              {
                "fulfillment_content": {
                  "fulfillment_uri": "product/resource/2001d044d41140d53ce9e57d793a4321",
                  "text": "",
                  "name": "课程履约图片"
                },
                "fulfillment_type": 3
              }
            ],
            "purchase_precaution": "小程序内购买课程为课程兑换权益,购买成功后将自动兑换到您的账户内,可在****中重复学习观看。",
            "qualification_uris": [
              "product/resource/1001d044d41140d53ce9e57d793a4321"
            ],
            "second_class": 30100,
            "third_class": 0,
            "title": "python入门教程"
          },
          "course_info": {
            "teacher_introduction": "华语知名唱片制作人"
          },
          "product_id": 7088891387520812000,
          "product_status": {
            "reject_reason": "",
            "status": 1
          },
          "product_type": 1
        },
        "product_reviewing": {
          "common_product_info": {
            "anchor_info": {
              "video_anchor_info": {
                "anchor_title": "python入门指南"
              }
            },
            "appid": "tt77fd0140e89bba8401",
            "first_class": 30000,
            "industry_type": 1,
            "path_info_lst": [
              {
                "path": "page/index/index",
                "query": {
                  "curriculum_id": "9283746293"
                }
              }
            ],
            "price_info": {
              "price": 100,
              "real_price": 98,
              "unit": "天"
            },
            "product_detail_lst": [
              {
                "img_uri": "product/resource/f515d1e894139856877b9a31877e6887",
                "text": "课程详情"
              }
            ],
            "product_fulfillment_lst": [
              {
                "fulfillment_content": {
                  "fulfillment_uri": "product/resource/0001d044d41140d53ce9e57d793a4321",
                  "text": "",
                  "name": "课程履约视频"
                },
                "fulfillment_type": 1
              },
              {
                "fulfillment_content": {
                  "fulfillment_uri": "product/resource/1001d044d41140d53ce9e57d793a4321",
                  "text": "",
                  "name": "课程履约音频"
                },
                "fulfillment_type": 2
              },
              {
                "fulfillment_content": {
                  "fulfillment_uri": "product/resource/2001d044d41140d53ce9e57d793a4321",
                  "text": "",
                  "name": "课程履约图片"
                },
                "fulfillment_type": 3
              }
            ],
            "purchase_precaution": "小程序内购买课程为课程兑换权益,购买成功后将自动兑换到您的账户内,可在****中重复学习观看。",
            "qualification_uris": [
              "product/resource/1001d044d41140d53ce9e57d793a4321"
            ],
            "second_class": 30100,
            "third_class": 0,
            "title": "python入门教程"
          },
          "course_info": {
            "teacher_introduction": "华语知名唱片制作人"
          },
          "product_id": 7088891387520812000,
          "product_status": {
            "reject_reason": "",
            "status": 2
          },
          "product_type": 1
        }
      }
    ]
  }
}

异常示例

{
  "err_msg": "无效的AccessToken",
  "err_no": 10001,
  "log_id": "2022042713370101022508421703050876"
}

枚举参数

fulfillment_type--履约类型

履约类型

履约类型编码

上传方式

视频

1

课程资源上传接口上传

音频

2

课程资源上传接口上传

图片

3

课程资源上传接口上传

文字

4

功能接口字段中直接携带上传

图文

5

课程资源上传接口上传

富文本

6

功能接口字段中直接携带上传

其他

100

课程资源上传接口上传

点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助