掃碼支付10元,閱讀完整文章!

?

網(wǎng)校小程序服務(wù)端接口文檔

登錄注冊類(lèi)接口

  • 解析微信code

API地址

/api/plugins/we_chat_app/sessions/{code}

Header

Accept:?"application/vnd.edusoho.v2+json"

請求類(lèi)型

GET

入參

參數名

類(lèi)型

含義

是否必傳

備注

無(wú)入參

?

?

?

?

?

?

?

?

?

?

?

?

?

?

出參

參數名

類(lèi)型

含義

備注

openid

String

Openid

后面很多接口要用到這個(gè)openid

session_key

String

Session_key

?

?

?

?

?

?

?

?

?

?

  • 登錄已存在的網(wǎng)校用戶(hù)

API地址

/api/plugins/we_chat_app/login

Header

Accept:?"application/vnd.edusoho.v2+json"

請求類(lèi)型

POST

dataType

txt

入參

參數名

類(lèi)型

含義

是否必傳

備注

?

appId

String

微信小程序appId

?

?

type

String

終端類(lèi)型

wechat_app

?

password

String

網(wǎng)校賬號密碼

?

?

openId

String

openid

?

?

identify

String

網(wǎng)校賬號ID

?

?

出參

參數名

類(lèi)型

含義

備注

?

token

String

登錄token

?

?

user

object

網(wǎng)校賬號信息

?

?

?

?

?

?

?

錯誤碼(不是全部錯誤碼,只提供了重要錯誤)

?

錯誤碼

信息

備注

?

12

已存在綁定關(guān)系

說(shuō)明用戶(hù)已完成微信與網(wǎng)校賬號的綁定操作,可調用token接口做登錄操作,獲取登錄token

?

?

  • Token接口(獲取登錄信息)

API地址

/api/plugins/we_chat_app/token

Header

Accept:?"application/vnd.edusoho.v2+json"

請求類(lèi)型

POST

入參

參數名

類(lèi)型

含義

是否必傳

備注

?

appId

String

微信小程序appId

?

?

type

String

終端類(lèi)型

Type = wechat_app

?

openId

String

openId

?

?

出參

參數名

類(lèi)型

含義

備注

?

token

String

登錄token

?

?

user

object

網(wǎng)校賬號信息

?

?

?

?

?

?

?

錯誤碼(不是全部錯誤碼,只提供了重要錯誤)

?

錯誤碼

信息

備注

?

11

用戶(hù)未綁定

遇到此錯誤,應引導用戶(hù)去做賬號綁定操作

?

?

  • 發(fā)送注冊短信驗證碼

API地址

/api/plugins/we_chat_app/smscenter

Header

Accept:?"application/vnd.edusoho.v2+json"

請求類(lèi)型

POST

dataType

txt

入參

參數名

類(lèi)型

含義

是否必傳

備注

?

type

String

驗證碼類(lèi)型

Type = register

?

mobile

String

手機號碼

?

?

?

?

?

?

?

?

出參

參數名

類(lèi)型

含義

備注

?

smsToken

String

短信驗證碼token

調用注冊接口時(shí)需要使用

?

?

?

?

?

?

?

  • 注冊網(wǎng)校賬號(手機號)

API地址

/api/plugins/we_chat_app/smscenter

Header

Accept:?"application/vnd.edusoho.v2+json"

請求類(lèi)型

POST

dataType

txt

入參

參數名

類(lèi)型

含義

是否必傳

備注

?

appId

String

微信小程序appId

?

?

type

String

終端類(lèi)型

Type = wechat_app

?

password

String

網(wǎng)校賬號密碼

?

?

openId

String

openId

?

?

mobile

String

手機號

?

?

smsCode

String

注冊驗證碼

?

?

nickname

String

網(wǎng)校昵稱(chēng)

?

?

token

String

登錄token

?

?

avatar

String

頭像URL

?

?

出參

參數名

類(lèi)型

含義

備注

?

token

String

登錄token

?

?

user

object

網(wǎng)校賬號信息

?

?

?

課程類(lèi)接口

  • 首頁(yè)展示數據

API地址

/api/pages/miniprogram/discoveries

Header

Accept:?"application/vnd.edusoho.v2+json"

請求類(lèi)型

POST

入參

參數名

類(lèi)型

含義

是否必傳

備注

?

token

String

登錄token

?

?

出參

參數名

類(lèi)型

含義

備注

?

Json列表

Json

課程列表,VIP信息列表

每個(gè)列表項對應一個(gè)首頁(yè)的展示模塊

?

?

  • 所有課程界面-課程菜單

API地址

/mapi_v2/Category/getCategorieTree

請求類(lèi)型

Get

入參

參數名

類(lèi)型

含義

是否必傳

備注

?

無(wú)

?

?

?

?

?

出參

參數名

類(lèi)型

含義

備注

?

JSON

Json

課程列表

?

?

?

  • 所有課程列表(“更多”按鈕)

API地址

/api/plugins/we_chat_app/course?sort=recommendedSeq&offset=0&limit=10

Header

Accept:?"application/vnd.edusoho.v2+json"

請求類(lèi)型

Get

入參

參數名

類(lèi)型

含義

是否必傳

備注

?

sort

String

排序方式

?

?

offset

int

從第幾條數據開(kāi)始獲取

?

?

limit

int

顯示幾條數據

?

?

categoryId

Int

課程分類(lèi)ID

篩選對應分類(lèi)的課程列表時(shí)使用

?

出參

參數名

類(lèi)型

含義

備注

?

JSON

Json

課程列表

?

?

?

  • 獲得課程信息(課程頁(yè)面)

API地址

/api/pages/miniprogram/courses/{課程ID}

Header

Accept:?"application/vnd.edusoho.v2+json"

請求類(lèi)型

POST

入參

參數名

類(lèi)型

含義

是否必傳

備注

?

token

String

登錄token

?

?

出參

參數名

類(lèi)型

含義

備注

?

courseItems

Json

課程目錄列表

?

?

courseSet

Json

課程標題、課程介紹、課程價(jià)格

?

?

learningExpiryDate

Json

學(xué)習有效期

?

?

learnMode

String

學(xué)習方式

freeMode = 免費

?

reviews

Json

學(xué)員評價(jià)列表

?

?

teachers

Json

教師列表

?

?

?

  • 加入學(xué)習

API地址

/api/courses/{課程ID}/members

Header

Accept:?"application/vnd.edusoho.v2+json"

請求類(lèi)型

POST

入參

參數名

類(lèi)型

含義

是否必傳

備注

?

token

String

登錄token

?

?

出參

參數名

類(lèi)型

含義

備注

?

JSON

Json

返回值

包含課程到期時(shí)間等信息

?

?

  • 打開(kāi)課時(shí)(獲得課時(shí)信息)

API地址

/api/plugins/we_chat_app/lesson/{課時(shí)ID}

Header

Accept:?"application/vnd.edusoho.v2+json"

請求類(lèi)型

POST

入參

參數名

類(lèi)型

含義

是否必傳

備注

?

token

String

登錄token

?

?

出參

參數名

類(lèi)型

含義

備注

?

JSON

Json

課時(shí)信息

包含課時(shí)類(lèi)型,視頻URL等

?

?

?

我的學(xué)習接口

  • 我的課程列表接口

API地址

/api/me/courses?sort=created_time&offset=0&limit=10

Header

Accept:?"application/vnd.edusoho.v2+json"

請求類(lèi)型

Get

入參

參數名

類(lèi)型

含義

是否必傳

備注

?

sort

String

排序方式

?

?

offset

int

從第幾條數據開(kāi)始獲取

?

?

limit

String

獲取多少條數據

?

?

出參

參數名

類(lèi)型

含義

備注

?

JSON

Json

我的課程列表

?

?

?

  • 我的班級列表接口

API地址

/api/me/classrooms?sort=created_time&offset=0&limit=10&format=pagelist

Header

Accept:?"application/vnd.edusoho.v2+json"

請求類(lèi)型

Get

入參

參數名

類(lèi)型

含義

是否必傳

備注

?

sort

String

排序方式

?

?

offset

int

從第幾條數據開(kāi)始獲取

?

?

limit

String

獲取多少條數據

?

?

出參

參數名

類(lèi)型

含義

備注

?

JSON

Json

我的班級列表

?

?

?

“我的”欄目接口

  • 我的信息接口

API地址

/api/me

Header

Accept:?"application/vnd.edusoho.v2+json"

請求類(lèi)型

POST

入參

參數名

類(lèi)型

含義

是否必傳

備注

?

token

String

登錄token

?

?

出參

參數名

類(lèi)型

含義

備注

?

Json

Json

用戶(hù)信息

包含頭像、昵稱(chēng)等

?

?

  • 我的訂單接口

API地址

/api/me/orders?offset=0&sort=-created_time

Header

Accept:?"application/vnd.edusoho.v2+json"

請求類(lèi)型

Get

入參

參數名

類(lèi)型

含義

是否必傳

備注

?

sort

String

排序方式

?

?

offset

int

從第幾條數據開(kāi)始獲取

?

?

出參

參數名

類(lèi)型

含義

備注

?

JSON

Json

我的訂單列表

?

?

?

開(kāi)通會(huì )員接口

  • 會(huì )員等級列表接口

API地址

/api/plugins/vip/vip_levels

Header

Accept:?"application/vnd.edusoho.v2+json"

請求類(lèi)型

POST

入參

參數名

類(lèi)型

含義

是否必傳

備注

?

token

String

登錄token

?

?

出參

參數名

類(lèi)型

含義

備注

?

Json

Json

會(huì )員等級列表

?

?

?

  • 會(huì )員等級對應的課程列表、班級列表接口

API地址

/api/plugins/vip/pages/h5/vips/{會(huì )員等級ID}

Header

Accept:?"application/vnd.edusoho.v2+json"

請求類(lèi)型

POST

入參

參數名

類(lèi)型

含義

是否必傳

備注

?

token

String

登錄token

?

?

出參

參數名

類(lèi)型

含義

備注

?

Json

Json

會(huì )員等級對應的課程列表、班級列表

?

?

?

  • “更多”課程列表

API地址

/api/plugins/vip/vip_courses?sort=-price&levelId=5&offset=0

Header

Accept:?"application/vnd.edusoho.v2+json"

請求類(lèi)型

Get

入參

參數名

類(lèi)型

含義

是否必傳

備注

?

sort

String

排序方式

?

?

offset

int

從第幾條數據開(kāi)始獲取

?

?

levelId

int

等級ID

?

?

出參

參數名

類(lèi)型

含義

備注

?

JSON

Json

課程列表

?

?

?

  • “更多”班級列表

API地址

/api/plugins/vip/vip_classrooms?sort=-price&levelId=5&offset=0

Header

Accept:?"application/vnd.edusoho.v2+json"

請求類(lèi)型

Get

入參

參數名

類(lèi)型

含義

是否必傳

備注

?

sort

String

排序方式

?

?

offset

int

從第幾條數據開(kāi)始獲取

?

?

levelId

int

等級ID

?

?

出參

參數名

類(lèi)型

含義

備注

?

JSON

Json

班級列表

?

?

?