零點校園開放接口文檔

成都零點信息技術有限公司

第

PAGE

13

頁共

NUMPAGES

13

頁

零點校園開放接口文檔

目錄

A接口：借零點校園體系的公眾號向用戶發(fā)微信客服消息(通知類)

B接口：通過零點校園用戶身份碼換取用戶手機號用于業(yè)務校驗

C接口：將外部訂單發(fā)入零點校園專送系統(tǒng)完成配送服務

開發(fā)前準備&開發(fā)者身份

請安排一個穩(wěn)定的管理層人員（最好是CEO或CTO），微信關注公眾號【零點校園生活圈】，然后在會員中心驗證最常用的手機號。最后將公司信息(視接口類型的需要)、管理者姓名、手機、職位簡介、開發(fā)者簽名(如發(fā)消息接口顯示在用戶收到消息的頭部)，等幾個信息發(fā)給零點總部對接經(jīng)理，用于添加注冊開發(fā)者身份。

零點校園總部電話QQ號：863230477或微信：lingdianzb。

添加成功后（正常情況10分鐘內(nèi)），會向開發(fā)者私發(fā)開發(fā)者CODE（developer_code）、開發(fā)者密鑰（developer_key）2個參數(shù)。

開發(fā)方若有人員變動或聯(lián)系方式更新，請及時反饋給零點總部，以防接口故障時及時聯(lián)絡。

A接口:借零點校園體系的公眾號向用戶發(fā)微信客服消息

1、應用場景：

第三方開發(fā)者可通過此接口，借零點校園總部公眾號或托管入零點開發(fā)平臺的其他公眾號向一個指定手機號的用戶發(fā)送一段微信客服文字消息。僅用于業(yè)務性通知，嚴禁營銷廣告內(nèi)容，如快遞取件通知、業(yè)績通知等。只需6個參數(shù)：開發(fā)者CODE、開發(fā)者密鑰、用戶手機號、通知內(nèi)容、訪問鏈接(需提前報備為白名單)、type=1(本接口特征碼固定勿修改)、時間戳。公眾號向用戶發(fā)微信客服消息成功或失敗，都會立即回調(diào)告知第三方開發(fā)者（若失敗可另作打算用其他方式觸達）。

因為本接口目前免費。所以您若需要向某用戶發(fā)業(yè)務性通知，可先調(diào)以上接口，成功則相當于免費觸達，不成功的再采用另外渠道如發(fā)短信等。故可節(jié)約大部分短信通道費還能更好的在消息中帶微信訪問鏈接喲！

請正常業(yè)務調(diào)用，嚴禁發(fā)送違法違規(guī)、廣告營銷、損害平臺利益的信息，違者必究！

2、密鑰簽名方案：

假設開發(fā)者密鑰(developer_key)：744ed968e7e1a4aebafa6f4888fced68來進行簽名。

2.1、參數(shù)篩選

獲取所有請求參數(shù)（不包括字節(jié)類型參數(shù)如文件、字節(jié)流），請?zhí)蕹齾?shù)名為sign、sign_type、key、developer_key的參數(shù)，同時還請?zhí)蕹齾?shù)值為''或null的參數(shù)。（注意：不要將developer_key參數(shù)加入到請求參數(shù)中）。

假定經(jīng)剔除篩選后的請求參數(shù)如下：

{

"developer_code":"U2QHNB2w=",

"tel":,

"content":"同學您好，您干洗的衣服已熨燙好了，放在店前臺處，記得過來取喲。",

"link":"/info/info_detail?info_id=165",

"type":"1",

"timestamp":

}

2.2、參數(shù)排序

按照參數(shù)名第一個字符的鍵值ASCII碼遞增排序（字母升序排序），如果遇到相同字符則按照第二個字符的鍵值ASCII碼遞增排序，以此類推。經(jīng)過參數(shù)排序之后參數(shù)為：

{

"content":"同學您好，您干洗的衣服已熨燙好了，放在店前臺處，記得過來取喲。",

"developer_code":"U2QHNB2w=",

"link":"/info/info_detail?info_id=165",

"tel":,

"timestamp":,

"type":"1"

}

2.3、參數(shù)拼接

將排序后的參數(shù)名與參數(shù)值，組合成“參數(shù)名=參數(shù)值”的格式，并把這些參數(shù)用&字符連接起來，此時生成的字符串為最初的待簽名字符串：

content=同學你好，你干洗的衣服已經(jīng)熨燙好了，放在我店前臺處，空了記得過來取喲。&developer_code=U2QHNB2w=&link=/info/info_detail?info_id=165&teltimestamptype=1

2.4、簽名

將上面拼接好的參數(shù)在尾部追加上開發(fā)者密鑰（developer_key），然后使用md5(）方法進行32位全小寫簽名：

md5("content=同學你好，你干洗的衣服已經(jīng)熨燙好了，放在我店前臺處，空了記得過來取喲。&developer_code=U2QHNB2w=&link=/info/info_detail?info_id=165&teltimestamptype=1744ed968e7e1a4aebafa6f4888fced68")

結(jié)果為：5f9ca34e51d31de1d931e3982c5b2833。

因此，接口參數(shù)中的密鑰簽名（即sign參數(shù)值）為：5f9ca34e51d31de1d931e3982c5b2833。

3、接口請求

接口URL：/api/Developer/sendWeChatMessage

請求方式：POST

請求Content-Type：application/x-www-form-urlencoded

請求Body參數(shù)：如下表

參數(shù)

示例值

描述

developer_code

U2QHNB2w=

開發(fā)者CODE

sign

5f9ca34e51d31de1d931e3982c5b2833

密鑰簽名

tel

手機號

content

同學您好，您干洗的衣服已熨燙好了，放在店前臺處，記得過來取喲。

消息內(nèi)容

link

/info/info_detail?info_id=165

訪問鏈接

timestamp

時間戳

4、同步響應參數(shù)

參數(shù)

參數(shù)描述

code

狀態(tài)碼（100:請求成功且發(fā)成功;104:請求參數(shù)錯誤或請求頻繁;105:用戶不存在106:請求成功但發(fā)失?。?/p>

message

操作提示信息

data

響應接口數(shù)據(jù)

{

"code":104,

"message":"缺少請求參數(shù)",

"data":[]

}

{

"code":104,

"message":"請求參數(shù)錯誤：手機號為空或格式不正確",

"data":[]

}

{

"code":104,

"message":"請求超時",

"data":[]

}

{

"code":104,

"message":"請求過于頻繁，請稍后再試吧！",

"data":[]

}

{

"code":100,

"message":"請求成功且發(fā)送微信客服消息成功",

"data":[]

}

4.1、響應示例：

{

"code":106,

"message":"請求成功但發(fā)送微信客服消息失敗",

"data":[]

}

{

"code":106,

"message":"該用戶未關注公眾號，請?zhí)崾酒潢P注公眾號",

"data":[]

}

{

"code":105,

"message":"用戶不存在",

"data":[]

}

{

"code":104,

"message":"請求參數(shù)錯誤：您不是開發(fā)者或沒有對應權(quán)限",

"data":[]

}

{

"code":104,

"message":"請求參數(shù)錯誤：訪問鏈接未被加入白名單",

"data":[]

}

5、用戶接收到消息示例：

支持文字及鏈接喲。

B接口：通過零點校園用戶身份碼換取用戶手機號

1、應用場景：

第三方開發(fā)者可通過此接口獲取指定用戶的手機號用于業(yè)務校驗，如出示身份碼快速取快遞。只需4個參數(shù)：開發(fā)者CODE、開發(fā)者密鑰、用戶身份碼CODE、type=16(本接口特征碼固定勿修改)。獲取用戶的手機號成功或失敗，都會立即回調(diào)告知第三方開發(fā)者

（若失敗可另作打算）。

請正常業(yè)務調(diào)用，嚴禁惡意調(diào)用或高頻違規(guī)調(diào)用，損害零點校園平臺利益者必究！

2、密鑰簽名方案：

假設獲得開發(fā)者密鑰（developer_key）：744ed968e7e1a4aebafa6f4888fced68來對請求參數(shù)進行簽名。

2.1、參數(shù)篩選

獲取所有請求參數(shù)（不包括字節(jié)類型參數(shù)如文件、字節(jié)流），請?zhí)蕹齾?shù)名為sign、sign_type、key、developer_key的參數(shù)，同時還請?zhí)蕹齾?shù)值為''或null的參數(shù)。（注意：不要將developer_key參數(shù)加入到請求參數(shù)中）。

假定經(jīng)剔除篩選后的請求參數(shù)如下：

{

"developer_code":"U2QHNB2w=",

"user_code":"U2TD844B2",

"type":"16",

"timestamp":

}

2.2、參數(shù)排序

按照參數(shù)名第一個字符的鍵值ASCII碼遞增排序（字母升序排序），如果遇到相同字符則按照第二個字符的鍵值ASCII碼遞增排序，以此類推。經(jīng)過參數(shù)排序之后參數(shù)為：

{

"developer_code":"U2QHNB2w=",

"timestamp":,

"type":"16",

"user_code":"U2TD844B2"

}

2.3、參數(shù)拼接

將排序后的參數(shù)名與參數(shù)值，組合成“參數(shù)名=參數(shù)值”的格式，并把這些參數(shù)用&字符連接起來，此時生成的字符串為最初的待簽名字符串：

developer_code=U2QHNB2w=×tamptype=16&user_code=U2TD844B2

2.4、簽名

將上面拼接好的參數(shù)在尾部追加上開發(fā)者密鑰（developer_key），然后使用md5(）方法進行32位全小寫簽名：

md5("developer_code=U2QHNB2w=×tamptype=16&user_code=U2TD844B2744ed968e7e1a4aebafa6f4888fced68")

結(jié)果為：6dce2061b71512a98f1fdbdbf29ce566。

因此，接口參數(shù)中的密鑰簽名（即sign參數(shù)值）為：6dce2061b71512a98f1fdbdbf29ce566。

3、接口請求

接口URL：/api/Developer/getUserTelByCode

請求方式：POST

請求Content-Type：application/x-www-form-urlencoded

請求Body參數(shù)：如下表

參數(shù)

示例值

描述

developer_code

U2QHNB2w=

開發(fā)者CODE

user_code

U2TD844B2

用戶身份碼CODE

sign

6dce2061b71512a98f1fdbdbf29ce566

密鑰簽名

timestamp

時間戳

4、同步響應參數(shù)

參數(shù)

參數(shù)描述

code

狀態(tài)碼（100:請求成功且返回了手機號;104:請求參數(shù)錯誤;105:請求成功但用戶不存在;106:請求成功但用戶未綁定手機號））

message

操作提示信息

data

響應接口數(shù)據(jù)(成功時為用戶手機號)

{

"code":100,

"message":"請求成功且返回了手機號",

"data"/p>

}

4.1、響應示例：

{

"code":104,

"message":"請求過于頻繁,請稍后再試吧！",

"data":[]

}

{

"code":104,

"message":"請求超時",

"data":[]

}

{

"code":104,

"message":"請求參數(shù)錯誤：信息已過期請重試",

"data":[]

}

{

"code":104,

"message":"缺少請求參數(shù)",

"data":[]

}

{

"code":104,

"message":"請求參數(shù)錯誤：您不是開發(fā)者或沒有對應權(quán)限",

"data":[]

}

{

"code":105,

"message":"該用戶碼不存在，請使用零點校園用戶身份碼",

"data":[]

}

{

"code":106,

"message":"該用戶還沒綁定手機號，請?zhí)崾酒浣壎?,

"data":[]

}

C接口：發(fā)外部單入零點校園專送

1、應用場景：

擁有自主訂單平臺的第三方開發(fā)運營者，可通過此接口將自己平臺產(chǎn)生且需要配送的訂單發(fā)入本校零點校園專送團隊，讓他們幫完成配送/取貨流程。最多只需10個參數(shù)：開發(fā)者CODE（developer_code）、開發(fā)者密鑰（developer_key）、關聯(lián)店CODE（shop_code）、來源標記類型(order_type)、該店單當日序號(daily_number)、目標電話(tel，可為空)、目標地址/備注(send_cont，可為空)、樓棟編碼(building_code，可為空)、type=128(本接口特征碼固定勿修改)、時間戳（timestamp）。接入成功后既可程序自動發(fā)單，也能在零點校園提供的一個微頁面手動發(fā)單。

來源標記類型（order_type）：“1”為美團，“2”為餓了么，“3”為百度，“4”為滴滴，“5”為其他。

與本校的零點校園專送團隊合作，讓小哥們幫您完成訂單配送/取貨環(huán)節(jié)，從此免除自建管理配送團隊的煩惱。配送費計扣費方案與零點校園專送團隊自主協(xié)商（由站長后臺配置）。

請正常業(yè)務調(diào)用，嚴禁惡意發(fā)單或發(fā)入違法違規(guī)的訂單，違者必究！

2、密鑰簽名方案：

假設獲得開發(fā)者密鑰（developer_key）：744ed968e7e1a4aebafa6f4888fced68來對請求參數(shù)進行簽名。

2.1、參數(shù)篩選

獲取所有請求參數(shù)（不包括字節(jié)類型參數(shù)如文件、字節(jié)流），請?zhí)蕹齾?shù)名為sign、sign_type、key、developer_key的參數(shù)，同時還請?zhí)蕹齾?shù)值為''或null的參數(shù)。（注意：不要將developer_key參數(shù)加入到請求參數(shù)中）。

假定經(jīng)剔除篩選后的請求參數(shù)如下：

{

"developer_code":"U2QHNB2w=",

"shop_code":"U2TD844B2",

"order_type":"1",

"daily_number":"1",

"tel":,

"send_cont":"從二號門進",

"building_code":"BTEGNAZl",

"timestamp":,

"type":"128"

}

2.2、參數(shù)排序

按照參數(shù)名第一個字符的鍵值ASCII碼遞增排序（字母升序排序），如果遇到相同字符則按照第二個字符的鍵值ASCII碼遞增排序，以此類推。經(jīng)過參數(shù)排序之后參數(shù)為：

{

"building_code":"BTEGNAZl",

"daily_number":"1",

"developer_code":"U2QHNB2w=",

"order_type":"1",

"send_cont":"從二號門進",

"shop_code":"U2TD844B2",

"tel":,

"timestamp":,

"type":"128"

}

2.3、參數(shù)拼接

將排序后的參數(shù)名與參數(shù)值，組合成“參數(shù)名=參數(shù)值”的格式，并把這些參數(shù)用&字符連接起來，此時生成的字符串為最初的待簽名字符串：

building_code=BTEGNAZl&daily_number=1&developer_code=U2QHNB2w=&order_type=1&send_cont=從二號門進&shop_code=U2TD844B2&teltimestamptype=128744ed968e7e1a4aebafa6f4888fced68

2.4、簽名

將上面拼接好的參數(shù)在尾部追加上開發(fā)者密鑰（developer_key），然后使用md5(）方法進行32位全小寫簽名：

md5("building_code=BTEGNAZl&daily_number=1&developer_code=U2QHNB2w=&order_type=1&send_cont=從二號門進&shop_code=U2TD844B2&tel=13311112