接口文檔

一、自定義打印接口 二、附件打印接口 三、打印接口回調 四、自定義生成圖片接口 五、復打接口 六、硬件狀態接口

一、自定義打印接口

如有打印發貨單等其他類打印需求,可使用該接口。通過管理後台模板配置,配置自定義模板,實現自定義打印功能。

1.1 接口格式

提供統一格式的HTTP POST或GET調用接口,並返回統一格式JSON數據。

1.2 請求地址

//poll.kuaidi100.com/printapi/printtask.do

請求參數(header)

名稱類型默認值
Content-Typestringapplication/x-www-form-urlencoded

請求參數(body)

參數名是否必填類型説明
methodstring業務類型(默認:printOrder)
keystring授權碼,請申請企業版獲取
signstring32位大寫,簽名,用於驗證身份,按MD5 (param +t+key+ secret)的順序進行MD5加密,不需要加上“+”號,secret在企業管理後台的企業信息中查看
tstring時間戳如:1576123932000
paramparam由其他字段拼接

param數據結構:

參數名是否必填類型説明
orderIdstring貴司內部自定義的訂單編號,需要保證唯一性,非必填
tempidstring通過管理後台的打印模板配置信息獲取
siidstring打印設備,通過打印機輸出的設備碼進行獲取
heightstring打印紙的高度,以mm為單位,例如:100
widthstring打印紙的寬度,以mm為單位,例如:75
saltstring簽名用隨機字符串
callBackUrlstring打印狀態回調地址
******string其他面單特殊需求參數顯示,可以到後台-面單模板選擇該模板,下方有對應產生列表

1.3 返回結果

字段類型説明備註
resultboolean提交結果true提交成功,false失敗
returnCodestring返回編碼
messagestring返回報文描述
datadata

data數據結構

字段類型説明備註
taskIdstring任務ID
************其他報文

1.4 返回結果示例

{       "result": true,     "returnCode": "200",     "message": "提交成功",     "data": {         "taskId": "****",  // 任務ID         ******   } } 

1.5信息代碼含義

代碼字段含義
200提交成功
400參數錯誤
600您不是合法的用户(即授權Key出錯)
601KEY已過期
500服務器錯誤(即快遞100的服務器處理間隙或臨時性異常,有時如果因為不按規範提交請求,比如快遞公司參數寫錯等,也會報此錯誤)
501重複提交
503驗證簽名失敗

二、附件打印接口

為各應用產品提供的智能化打印解決方案。對接後可以讓企業、個人實現PC/手機無線打印,遠程打印,多人共享打印。打印內容包括但不限於文檔、發票、發貨單、快遞單等,搭配雲盒使用,支持激光、噴墨、針式、熱敏打印機類型。讓企業和個人打印更高效、更便捷。 通過接口上傳打印內容,圖片或PDF、Word等文件,即可打印該內容。

2.1 接口格式

提供統一格式的HTTP POST或GET調用接口,並返回統一格式JSON數據。

2.2 請求地址

//poll.kuaidi100.com/printapi/printtask.do

請求參數(header)

名稱類型默認值
Content-Typestringapplication/x-www-form-urlencoded

請求參數(body)

參數名是否必填類型説明
methodstring業務類型(默認:imgOrder)
keystring授權碼,請申請企業版獲取
signstring32位大寫,簽名,用於驗證身份,按MD5 (param +t+key+ secret)的順序進行MD5加密,不需要加上“+”號,secret在企業管理後台的企業信息中查看
tstring時間戳如:1576123932000
paramparam由其他字段拼接
filefile需要打印的附件

param數據結構:

參數名是否必填
orderIdstring貴司內部自定義的訂單編號,需要保證唯一性,非必填
heightstring打印紙的高度,以mm為單位,例如:100
widthstring打印紙的寬度,以mm為單位,例如:75
copyNumstring需要打印的份數,默認是一份
startPagestring打印範圍,起始頁,僅對多頁文件支持,默認是打印整個文檔
endPagestring打印範圍,結束頁,僅對多頁文件支持,默認是打印整個文檔
saltstring簽名用隨機字符串
siidstring打印設備,通過打印機輸出的設備碼進行獲取
callBackUrlstring打印狀態回調地址

2.3 返回結果

字段類型説明備註
resultboolean提交結果true提交成功,false失敗
returnCodestring返回編碼
messagestring返回報文描述
datadata

data數據結構

字段類型説明備註
taskIdstring任務ID
************其他報文

2.4 返回結果示例

{       "result": true,     "returnCode": "200",     "message": "提交成功",     "data": {         "taskId": "****",  // 任務ID          ******   } } 

2.5信息代碼含義

代碼字段含義
200提交成功
400參數錯誤
600您不是合法的用户(即授權Key出錯)
601KEY已過期
500服務器錯誤(即快遞100的服務器處理間隙或臨時性異常,有時如果因為不按規範提交請求,比如快遞公司參數寫錯等,也會報此錯誤)
501重複提交
503驗證簽名失敗

三、打印接口回調

通過上述接口提交的打印請求,進行打印狀態返回。

3.1 接口格式

提供統一格式的HTTP POST或GET調用接口,並返回統一格式JSON數據。

3.2 請求地址

<form method="post" name="" action="[callbackUrl]">     <input type="text" name="taskId" value="{XXX}" />     <input type="text" name="param" value="{XXX}" />     <input type="text" name="sign" value="簽名字符串" /> </form> 

請求參數:

字段類型説明備註
taskIdstring任務ID
signstring加密字符串簽名:MD5 (param +salt)
paramparam參數主體

param數據結構:

參數名類型説明
statusstring狀態編碼,200:打印成功,201打印不成功
messagestring狀態描述

3.3 返回結果

字段類型説明備註
resultboolean提交結果true提交成功,false失敗
returnCodestring返回編碼
messagestring返回報文描述

3.4 返回結果示例

{       "result": true,     "returnCode": "200",     "message": "提交成功" } 

説明:

字段名稱字段含義
resulttrue表示成功,false表示失敗。如果提交回調接口的地址失敗,30分鐘後重新回調,3次仍舊失敗的,自動放棄
returnCode200: 提交成功 500: 服務器錯誤 其他錯誤請自行定義
message返回的提示

其他信息快遞100會忽略。

四、自定義生成圖片接口

使用該接口可以自定義生成面單,發貨單等的信息圖片,並通過本地打印機打印。

4.1 接口格式

提供統一格式的HTTP POST或GET調用接口,並返回統一格式JSON數據。

4.2 請求地址

//poll.kuaidi100.com/printapi/printtask.do

請求參數(header)

名稱類型默認值
Content-Typestringapplication/x-www-form-urlencoded

請求參數(body):

參數名是否必填類型説明
methodstring業務類型(默認:默認:getPrintImg)
keystring授權碼,請申請企業版獲取
signstring32位大寫,簽名,用於驗證身份,按MD5 (param +t+key+ secret)的順序進行MD5加密,不需要加上“+”號,secret在企業管理後台的企業信息中查看
tstring時間戳如:1576123932000
paramparam由其他字段拼接

param數據結構:

參數名是否必填類型説明
typestring業務類型,值為:30
orderIdstring貴司內部自定義的訂單編號,需要保證唯一性,非必填
tempidstring通過管理後台的打印模板配置信息獲取
heightstring打印紙的高度
widthstring打印紙的寬度
**string其他面單參數顯示,可以到後台-面單模板選擇該模板,下方有對應產生列表

4.3 返回結果

字段類型説明備註
resultboolean提交結果true提交成功,false失敗
returnCodestring返回編碼
messagestring返回報文描述
datadata

data數據結構

字段類型説明備註
taskidstring任務ID
imgBase64string面單BASE64編碼圖片
************其他報文

4.4 返回結果示例

{       "result": true,     "returnCode": "200",     "message": "提交成功",     "data": {         "taskId": "****",     // 任務ID         "imgBase64": "****",  //面單BASE64編碼圖片           ******    } } 

4.5 信息代碼含義

代碼字段含義
200提交成功
400參數錯誤
600您不是合法的用户(即授權Key出錯)
601KEY已過期
500服務器錯誤(即快遞100的服務器處理間隙或臨時性異常,有時如果因為不按規範提交請求,比如快遞公司參數寫錯等,也會報此錯誤)
501重複提交
503驗證簽名失敗

五、復打接口

對短期內打印過的面單進行復打操作。 該接口支持在提交打印請求2天內的打印任務進行復打10次的操作。

5.1 接口格式

提供統一格式的HTTP POST或GET調用接口,並返回統一格式JSON數據。

5.2 請求地址

//poll.kuaidi100.com/printapi/printtask.do

請求參數(header)

名稱類型默認值
Content-Typestringapplication/x-www-form-urlencoded

請求參數(body)

參數名是否必填類型説明
methodstring業務類型(默認:printOld)
keystring授權碼,請申請企業版獲取
signstring32位大寫,簽名,用於驗證身份,按MD5 (param +t+key+ secret)的順序進行MD5加密,不需要加上“+”號,secret在企業管理後台的企業信息中查看
tstring時間戳如:1576123932000
paramparam由其他字段拼接

param數據結構

參數名是否必填類型説明
taskIdstring任務ID

5.3 返回結果

字段類型説明備註
resultboolean提交結果true提交成功,false失敗
returnCodestring返回編碼
messagestring返回報文描述

5.4 返回結果示例

{       "result": true,     "returnCode": "200",     "message": "復打成功", } 

5.5 信息代碼含義

代碼字段含義
200提交成功
201查無此單,可能調用過期或復打次數超額
400參數錯誤
600您不是合法的用户(即授權Key出錯)KEY已過期
601KEY已過期
500服務器錯誤(即快遞100的服務器處理間隙或臨時性異常,有時如果因為不按規範提交請求,比如快遞公司參數寫錯等,也會報此錯誤)
501重複提交
503驗證簽名失敗

六、 硬件狀態接口

獲取雲打印機設備通訊狀態。

6.1 接口格式

提供統一格式的HTTP POST或GET調用接口,並返回統一格式JSON數據。

6.2 請求地址

//poll.kuaidi100.com/printapi/printtask.do

請求參數:

參數名是否必填類型説明
methodstring業務類型(默認:devstatus)
keystring授權碼,請申請企業版獲取
signstring32位大寫 ,簽名,用於驗證身份,按MD5 (param +t+key+ secret)的順序進行MD5加密,不需要加上“+”號,secret在企業管理後台查看
tstring時間戳如:1576123932000
paramparam由其他字段拼接

param數據結構:

參數名是否必填類型説明
siidstring設備碼

6.3 返回結果

字段類型説明備註
resultboolean提交結果true提交成功,false失敗
returnCodestring返回編碼
messagestring返回報文描述
datadata

data數據結構

字段類型説明備註
onLinestring設備狀態1,在線,0未在線

6.4 提供數據內容

{  		"result":true,  		"returnCode":"200",  		"message":"成功"  "data":{  	"onLine":"****"	//設備狀態  		}  }  

6.5 信息代碼含義

信息代碼字段含義
200提交成功
400參數錯誤
600您不是合法的用户(即授權Key出錯)
601KEY已過期
500獲取失敗
503驗證簽名失敗
504獲取受限
一、自定義打印接口 二、附件打印接口 三、打印接口回調 四、自定義生成圖片接口 五、復打接口 六、硬件狀態接口