接口約定

• 使用https
• restful風(fēng)格
• 用戶端：https://{域名}/api/{接口版本號(hào)}/{resource}/{resource_id}/{sub_resource}/{sub_resource_id}/{action}?{query_string}
• 管理端：https://{域名}/admin/api/{接口版本號(hào)}/{resource}/{resource_id}/{sub_resource}/{sub_resource_id}/{action}?{query_string}
• 測(cè)試環(huán)境域名babieta.xivan.cn
• 正式環(huán)境域名待定
• 公共參數(shù)放在header震束，如userid,session_key,unionid,version等
• resource: studies

接口

gcid算法

def gcid_hash_file(path):
    h = hashlib.sha1()
    size = os.path.getsize(path)
    psize = 0x40000
    while size / psize > 0x200 and psize < 0x200000:
        psize = psize << 1
    with open(path, 'rb') as stream:
        data = stream.read(psize)
        while data:
            h.update(hashlib.sha1(data).digest())
            data = stream.read(psize)
    return h.hexdigest()

GET /studies/auth/qiniu/tokens/<gcid>

例

curl -XGET https://babieta.xivan.cn/api/v1.0/auth/qiniu/tokens/abc

返回?cái)?shù)據(jù)：

例

{
    "code"0,
    "msg":"",
    "token":"xxxx",
    "key":"yyyy"
}

GET /studies/{studies_id}/contents

請(qǐng)求數(shù)據(jù)：

query_string 參數(shù)/可選參數(shù)

例

curl -i "https://babieta.xivan.cn/api/v1.0/studies/express/contents?limit=1&level=3" -H "userid:oslC94mGqAAEz6iWhKhL9dEY5l3o" -H "token:25e8ba0469c6f1c0c6dcd4fe952b8e4e"

wx.request({
      "url":"https://babieta.xivan.cn/api/v1.0/studies/express/contents?limit=1", 
      "method":"GET",
      "success": res =>{
        console.log(res)
      },
      "data":{limit:'1'},
      "dataType":"json", 
      "header": { "content-type":"application/x-www-form-urlencoded",
        "userid": "oslC94mGqAAEz6iWhKhL9dEY5l3o", "token":"25e8ba0469c6f1c0c6dcd4fe952b8e4e"},
      "complete": res => {
        console.log(res)
      }
    })

返回?cái)?shù)據(jù)：

object->express_info(表達(dá)訓(xùn)練)

object->soak_info(浸泡訓(xùn)練)

object->communication_info(交流訓(xùn)練)

例

{
    "msg": "",
    "code": 0,
    "list": [{"id":1, "cover_url":"111", "audio_url":"222", "word_chi":"111", "audio_text":"333"}]
}

POST /studies/{studies_id}/contents/{contents_id}/report

請(qǐng)求數(shù)據(jù)：

body 參數(shù)/可選參數(shù) (get)

例

curl -XPOST -i "https://babieta.xivan.cn/admin/api/v1.0/studies/express/contents/3" -H "Content-Type:application/json" -d '{"duration":"100"}' -H "userid:oslC94mGqAAEz6iWhKhL9dEY5l3o" -H "token:25e8ba0469c6f1c0c6dcd4fe952b8e4e"

返回?cái)?shù)據(jù)：

GET /studies/communication/contents/<content_id>/sound_records

請(qǐng)求數(shù)據(jù)：

query_string 參數(shù)/可選參數(shù)

例

curl -i "https://babieta.xivan.cn/api/v1.0/studies/communication/contents/4/sound_records?limit=10" -H "userid:oslC94mGqAAEz6iWhKhL9dEY5l3o" -H "token:25e8ba0469c6f1c0c6dcd4fe952b8e4e"

wx.request({
      "url":"https://babieta.xivan.cn/api/v1.0/studies/communication/contents/4/sound_records", 
      "method":"GET",
      "success": res =>{
        console.log(res)
      },
      "data":{limit:'10'},
      "dataType":"json", 
      "header": { "content-type":"application/x-www-form-urlencoded",
        "userid": "oslC94mGqAAEz6iWhKhL9dEY5l3o", "token":"25e8ba0469c6f1c0c6dcd4fe952b8e4e"},
      "complete": res => {
        console.log(res)
      }
    })

返回?cái)?shù)據(jù)：

例

{
    "msg": "",
    "code": 0,
    "list": [{"id":1, "audio_duration":111, "audio_url":"222", "user_name":"111", "user_portrait":"333", "praise_count":3}]
}

GET /studies/communication/contents/<content_id>/history_sound_records

請(qǐng)求數(shù)據(jù)：

query_string 參數(shù)/可選參數(shù)

例

curl -i "https://babieta.xivan.cn/api/v1.0/studies/communication/contents/1,2,3,4/history_sound_records?limit=10" -H "userid:oslC94mGqAAEz6iWhKhL9dEY5l3o" -H "token:25e8ba0469c6f1c0c6dcd4fe952b8e4e"

wx.request({
      "url":"https://babieta.xivan.cn/api/v1.0/studies/communication/contents/1,2,3,4/history_sound_records", 
      "method":"GET",
      "success": res =>{
        console.log(res)
      },
      "data":{limit:'10'},
      "dataType":"json", 
      "header": { "content-type":"application/x-www-form-urlencoded",
        "userid": "oslC94mGqAAEz6iWhKhL9dEY5l3o", "token":"25e8ba0469c6f1c0c6dcd4fe952b8e4e"},
      "complete": res => {
        console.log(res)
      }
    })

返回?cái)?shù)據(jù)：

例

{
    "msg": "",
    "code": 0,
    "list": [[{"id":1, "audio_duration":111, "audio_url":"222", "user_name":"111", "user_portrait":"333", "praise_count":3}, ...], [], [], []]
}

POST /studies/communication/contents/<content_id>/sound_records/commit

請(qǐng)求數(shù)據(jù)：

body 參數(shù)/可選參數(shù)

返回?cái)?shù)據(jù)：