1.登錄
URL:https://v3.youbanghelper.com/api/auth
method:POST
data:{username:name,password:password}
return :200: {
token_type: "bearer",?
access_token: "977ca0dddd29046769a0a41d0106cafef2d46a5d",
?expires_in: 3600
}
401/400:{code: 400, error: "invalid_grant", error_description: "User credentials are invalid"}
2.檢測登錄狀態(tài)
URL:https://v3.youbanghelper.com/api/auth
method:GET
return:{"status":0,"msg":"ok","data":{"companyInfo":{"name":"溫江錦秀城","id":"597ef91d223bdd24ab040c4a"},"username":"春香","_id":"5982e4f9060e872da6385283","phone":"18508210931"}}
3.獲取網(wǎng)點信息
URL:https://server3.youbanghelper.com/api/site/{siteId} // companyInfo.id;
method:GET
return {"status":0,"msg":"ok","data":{"_id":"597ef91d223bdd24ab040c4a","name":"溫江錦秀城","address":"錦秀城1幢與2幢之間友幫管家","phone":"17318687052","desc":"溫江錦秀城","location":"103.856646,30.682203","master":"趙蓉","status":"正在營業(yè)","pid":"597c7afae624113928b67ba7","ctime":"2017-07-31","__v":0,"smshasshelf":false,"sms":{"signname":"優(yōu)邦管家"},"tc":"21:00","to":"09:00","type":1,"shelf":["A","生鮮","大件"],"slug":"site"}}
有用的信息是shelf:貨架設(shè)置
4.獲取快遞單位
URL:https://server3.youbanghelper.com/api/partner?type=partner
method:GET
return? {"status":0,"msg":"ok","data":{"total":25,"limit":200,"page":1,"data":[{"_id":"59c22d8874e2e2057be3d4f1","username":"韻達(dá)楊國慶","expresscompany":"韻達(dá)","phone":"13699040467","price":"0.3","desc":"","ctime":"2017-09-20”]}}
5.派件入庫
URL:https://server3.youbanghelper.com/api/packages
method:POST
data:{
code:"654324565432345", //快遞單號
expresscompany:"韻達(dá)",//快遞公司名稱
partner:"59c22d8874e2e2057be3d4f1",//快遞單位id
partnername:"韻達(dá)楊國慶",//快遞單位名稱
phone:"17002818900",//收件人電話
shelf:0,// 貨架索引
smsSend:true,//是否發(fā)送短信
status:0,//狀態(tài) 0 入庫 1 出庫 9 異常
}
6.獲取電話提示（輸入的號碼長度大于4的時候才觸發(fā)，提高匹配效率）
URL:https://server3.youbanghelper.com/api/custom/phonetips?phone={phone}
methoed:GET
return {"status":0,"msg":"ok","data":{"_id":"59fd9971788c3f082a054692","phone":"17002818900"}}
7.出庫
URL：https://server3.youbanghelper.com/api/packages/chuku
data:{code: "7654567876543456765"? // 單號, id: "5a01656fa87bd339e9c67b3c"http://文檔id}? // 派件詳情里面出庫
data:{code:"072"} //? ?取件碼出庫? 取件碼長度小于5
data:{code:"7654567876543456765"}? ?// 單號出庫
methoed:PUT
return?{"status":0,"msg":"ok","data":{"ok":1,"nModified":1,"n":1,"opTime":{"ts":"6485672900706697217","t":4},"electionId":"7fffffff0000000000000004"}}
n > 1? ?出庫成功? ?
n = 0? ?出庫失敗，這個包裹沒有入庫
8.包裹列表? ?https://api.youbanghelper.com/api/packages?code=&phone=&status=&partner=&secret=&star=&end=&page=2&pageSize=20
code:單號支持模糊
phone：手機(jī)后四位
partner：快遞單位id
secret：取件碼
page:分頁
pageSize：每頁條數(shù)
各個參數(shù)可自由組合
{"status":0,"msg":"ok","data":{"total":520 // 共計,"limit":20 // 每頁條數(shù),"page":2 //分頁 ,
"data[{"_id":"59f7f1d2c5c74f049435374c","code":"456876543234567654321","partner":"59f2fa35aeef4d2dca14e2dc","partnername":"申通麗麗","phone":"17002818900","status":1,"intime":"2017-10-31 11:45:22","serial":"31-1","smsstatus":"設(shè)置為不發(fā)送","desc":"無","shelf":"0","outtime":"2017-10-31 12:37:44"}]}}
