小巧便捷配置簡單的小票雲列印是外賣微信小程式列印小票的首選方案,飛鵝雲列印是很受歡迎的雲列印服務商,本文詳細介紹瞭如何通過開放API與飛鵝雲列印對接。 ...
外賣點餐在流程處理上是爭分奪秒的,大多數買家都是臨近飯點才點餐,這樣下單之後就會盼望著能儘快送到,作為點餐流程環節一部分的小票列印也就要求越便捷越省時間越好。小票雲列印因為其小巧便捷、無線聯網、自動列印而成為首選的外賣小程式小票列印解決方案。
酷客多外賣小程式的小票列印對接了易聯雲、飛鵝兩家,其中飛鵝小票印表機因為自帶接單語音提醒所以更受歡迎。雲列印的原理類似,對接方式大同小異。下文以飛鵝雲列印為例詳細說明。
1. 小票雲列印的工作原理
雲列印服務商在互聯網上發佈一套開放API作為小票雲服務,商家(從雲列印服務商)購買小票印表機後將印表機通過Wi-Fi連接互聯網,外賣小程式與開放API對接,完成小票印表機遠程註冊、推送待列印數據等工作。小票雲服務通過互聯網將待列印數據推送到對應的小票印表機,小票印表機列印出小票。
圖1 雲列印的工作原理
2. 飛鵝雲列印開放API
- 添加印表機到開發者賬戶(可批量)
- 列印訂單
- 刪除印表機(可批量)
- 修改印表機信息
- 清空待列印隊列
- 查詢訂單是否列印成功
- 查詢某台印表機某日訂單統計數
- 查詢某台印表機狀態
3. 對接開放API的準備工作
(1) 在飛鵝雲服務後臺註冊開發者賬戶
(2) 小票印表機接通電源,配置Wi-Fi密碼連接互聯網
飛鵝小票印表機接通電源後,會在小票上自動列印聯網配置的二維碼。手機改為Wi-Fi上網,用微信掃描二維碼,即出現填寫Wi-Fi密碼界面,填寫密碼後點擊“連接”按鈕連接網路,成功後印表機會列印一張小票給出提示。
圖2 微信掃碼配置印表機Wi-Fi密碼
4. 開發對接API的框架(列印框架)
(1) 列印框架類圖
框架支持水平擴展,可適配多家雲列印開放API。對應於開放API裡面的各個方法,一對一地編寫列印框架的方法。
框架方法與開放API的交互封裝在一個通用方法裡面,傳入參數、返回數據都是泛型,在具體的業務方法裡面傳遞相應的數據類型及實參。
圖3 列印框架類圖
圖4 封裝的對接方法
(2) 通用方法
1 /// <summary> 2 /// 調用飛鵝介面通用方法 3 /// </summary> 4 /// <typeparam name="TOutData">介面返回的業務實體類型</typeparam> 5 /// <typeparam name="TInData">介面傳入的業務實體類型</typeparam> 6 /// <param name="apiUrl">介面Url</param> 7 /// <param name="cityDistributionAccountOuterId">商戶編號(創建商戶賬號分配的編號),不需要時傳遞空字元串</param> 8 /// <param name="inData">介面傳入的業務實體</param> 9 /// <param name="isIncludeNullProperty">序列化業務實體時是否包含空值屬性</param> 10 /// <param name="needEscapeParameterValue">是否需要對參數值進行Url轉義,預設不需要</param> 11 /// <returns></returns> 12 public IApiResult<TOutData> CallFeiEApi<TOutData>(string apiUrl, string method, Dictionary<string, string> methodParameters, bool isIncludeNullProperty = true, bool needEscapeParameterValue = false) 13 { 14 ApiResult<TOutData> apiResult = new ApiResult<TOutData>(); 15 ApiParameterContainer apiParameterContainer = null; 16 17 try 18 { 19 string unixTimestamp = HttpAgent.GetUnixTimestamp(DateTime.Now); 20 apiParameterContainer = new ApiParameterContainer(unixTimestamp) 21 { 22 AppId = appId, 23 AppKey = appKey, 24 Signature = ComputeSign(appId, appKey, unixTimestamp), 25 ApiMethod = method 26 }; 27 28 if (methodParameters != null && methodParameters.Count > 0) 29 { 30 foreach (var methodParameter in methodParameters) 31 { 32 if (!apiParameterContainer.Parameters.ContainsKey(methodParameter.Key)) 33 { 34 apiParameterContainer.Parameters.Add(methodParameter.Key, methodParameter.Value); 35 } 36 } 37 } 38 39 // 40 // 調用介面,獲取返回值 41 // 42 string responseText = HttpAgent.DoPost(apiUrl, apiParameterContainer.Parameters, needEscapeParameterValue, "application/x-www-form-urlencoded"); 43 44 // 45 // 提取返回數據 46 // 47 apiResult = JsonConvert.DeserializeObject<ApiResult<TOutData>>(responseText); 48 } 49 catch (Exception ex) 50 { 51 Log(string.Format("調用飛鵝介面出錯,Url:{0},傳入數據:{1},錯誤:{2}", apiUrl, JsonConvert.SerializeObject(apiParameterContainer, Formatting.None), ex.ToString())); 52 } 53 54 return apiResult; 55 }
其中,ComputeSign()方法使用開發者Key計算出介面請求的哈希值,具體哈希演算法由每個雲列印服務商指定。HttpAgent.DoPost()方法將數據轉換為表單鍵值對序列形式發起POST請求,註意必須指定Web請求的ContentType標頭為“application/x-www-form-urlencoded”,否則無法正常使用開放API。
5. 在業務系統里使用列印框架
(1) 商家填寫並註冊印表機
商家從印表機的機身標簽查找編號、識別碼,填入表單,自定義一個印表機名稱以便於區分多台印表機,如果需要使用GPRS聯網則填入放置在印表機裡面的手機卡號。若要該印表機在接單時自動列印小票則勾選“接單自動小票列印”覆選框。
在保存時,商家後臺系統在本地保存印表機信息,並調用列印框架在雲端註冊印表機。註冊成功後則會顯示雲端註冊狀態為“已註冊”。
圖5 商家填寫並註冊印表機
(2) 商家手動列印小票
商家在商家後臺系統查詢、瀏覽所接的訂單,可以根據需要手動列印某個訂單的小票。列印時先選擇需要列印小票的一到多台印表機,點擊“列印”按鈕調用列印框架完成列印。
圖6 商家瀏覽訂單
圖7 商家選擇印表機
6. 附錄
飛鵝雲列印開發文檔:http://www.feieyun.com/open/index.html
飛鵝雲後臺(註冊開發者):http://admin.feieyun.com/
酷客多商家後臺:http://kukeduo.cn
酷客多小程式 陳蘇州