创建销售出库订单 websocket测试 POST http://sugou.test/v1/common/create_ck_order 说明 / 示例 # Onepage API文档 v1.0 ## 纸张 描述：获取无密码的纸张内容。根路径下动态路由，匹配/url123，但不匹配/url123/abc, 返回该路径对应的纸张，若设有密码，未获取到secret时返回403，获取到secret，解析base64，对比secret，若一致，返回200，不一致怎返回403，msg -2。 ## GET /[pageurl] #### Request - Header - secret `可选, base64` #### Response 1 - Header - 200 OK - Body ``` yaml text: xxx `纸张上的文本内容`, msg: success code: 0 ``` #### Response 2 - Header - 403 forbidden - Body ``` yaml msg: error, this page have secret. code: -1 ``` #### Response 3 - Header - 403 forbidden - Body ``` yaml msg: error, the secret is not match. code: -2 ``` ## POST /[pageurl] 描述：生成新的纸张。后端需校验用户token，url是否合法（允许数字、字母、下划线、连字符）。 - 正常响应 Response 1 - 超出页面数量超出限制 Response 2 - token错误、paegurl不存在或未传token Response 3 ### Request - Header - token - Body ``` yaml pageurl: xxx secret: base64 # 可选 ``` ### Response 1 - Header - 204 - Body ``` yaml # null, 只返回状态码，不返回body ``` ### Response 2 - Header - 400 - Body ``` yaml msg: error, page limit reached. code: -3 ``` ### Response 3 - Header - 403 - Body ``` yaml msg: error, token is wrong. code: -4 ``` ## PATCH /[pageurl] 描述：修改page内容。 - 正常响应 Response 1 - secret为空或不匹配 Response 2 ### Request - Header - secret `可选` - Body ``` yaml pageurl: xxx, text: xxx ``` ### Response 1 - Header 204 - Body `null` ### Response 2 - Header 400 - Body ``` yaml msg: error, secret is wrong. code: -5 ``` ## DELETE /[pageurl] 描述：删除pageurl对应的页面 ### Request - Header - token - Body ``` yaml pageurl: xxx ``` ### Response 1 - Header 204 - Body `null` ### Response 2 - Header - 403 - Body ``` yaml msg: error, authentication fail. code: -7 ``` ## 状态码对应关系 - 0 正常 - -1 纸张有密码保护 - -2 纸张secret错误 - -3 纸张数量达到上限 - -4 用户token不正确
# Onepage API文档 v1.0 ## 纸张 描述：获取无密码的纸张内容。根路径下动态路由，匹配/url123，但不匹配/url123/abc, 返回该路径对应的纸张，若设有密码，未获取到secret时返回403，获取到secret，解析base64，对比secret，若一致，返回200，不一致怎返回403，msg -2。 ## GET /[pageurl] #### Request - Header - secret `可选, base64` #### Response 1 - Header - 200 OK - Body ``` yaml text: xxx `纸张上的文本内容`, msg: success code: 0 ``` #### Response 2 - Header - 403 forbidden - Body ``` yaml msg: error, this page have secret. code: -1 ``` #### Response 3 - Header - 403 forbidden - Body ``` yaml msg: error, the secret is not match. code: -2 ``` ## POST /[pageurl] 描述：生成新的纸张。后端需校验用户token，url是否合法（允许数字、字母、下划线、连字符）。 - 正常响应 Response 1 - 超出页面数量超出限制 Response 2 - token错误、paegurl不存在或未传token Response 3 ### Request - Header - token - Body ``` yaml pageurl: xxx secret: base64 # 可选 ``` ### Response 1 - Header - 204 - Body ``` yaml # null, 只返回状态码，不返回body ``` ### Response 2 - Header - 400 - Body ``` yaml msg: error, page limit reached. code: -3 ``` ### Response 3 - Header - 403 - Body ``` yaml msg: error, token is wrong. code: -4 ``` ## PATCH /[pageurl] 描述：修改page内容。 - 正常响应 Response 1 - secret为空或不匹配 Response 2 ### Request - Header - secret `可选` - Body ``` yaml pageurl: xxx, text: xxx ``` ### Response 1 - Header 204 - Body `null` ### Response 2 - Header 400 - Body ``` yaml msg: error, secret is wrong. code: -5 ``` ## DELETE /[pageurl] 描述：删除pageurl对应的页面 ### Request - Header - token - Body ``` yaml pageurl: xxx ``` ### Response 1 - Header 204 - Body `null` ### Response 2 - Header - 403 - Body ``` yaml msg: error, authentication fail. code: -7 ``` ## 状态码对应关系 - 0 正常 - -1 纸张有密码保护 - -2 纸张secret错误 - -3 纸张数量达到上限 - -4 用户token不正确