Special statement:

1. Request URL:
http://api.jp.feieyun.com/Api/Open/
https://api.jp.feieyun.com:443/Api/Open/ (New addition)

API interface supports both http and https at the same time

2. Each The parameters of a request consist of two parts: public parameters and private parameters. For details, please see the corresponding description below.

3. The returned results are all data in json format.

4. Each of the following interfaces only lists the private parameters and the data parameters that return the results. For others, please see the description of the request and return public parameters.

Special note: The request written by the developer is submitted in the form of data, the request header needs to use Content-Type: application/x-www-form-urlencoded, please do not submit the data in other ways.

5. Download the relevant SDK and click to view

Request public parameter description:

Return to public parameter description

Add printers in batches, Open_printerAddlist

Function description:

To add printers in batches, please strictly refer to the format description:

E.g:

    316500010 # abcdefgh # Front desk # 13688889999
    316500011 # abcdefgh # kitchen # 13688889990

Request URL:

http://api.jp.feieyun.com/Api/Open/

Request method:

POST (recommended), GET

Public parameters:

Private parameters:

Return parameter description:

Return example:

correct:

{
    "ok":[
        "316500010# abcdefgh# Front desk  # 13688889999 ",
        "316500011# abcdefgh# Front desk  # 13688889999 "
        ],
    "no":[
        "316500012 # abcdefgh # Front desk  # 13688889999  (error: added)"
        ]
}

error:

{
    "msg":"Parameter error: parameter value cannot pass null character",
    "ret":-2,
    "data":null,
    "serverExecutedTime":37
}

Print order, Open_printMsg

Function description:

Send the order content that the user needs to print to the Feie Cloud small ticket printer (this interface can only be used by the small ticket machine, if you buy a label machine, please use the special interface for the label machine)

Request URL:

http://api.jp.feieyun.com/Api/Open/

Request method:

POST (recommended), GET

pay attention:

The request written by the developer must submit data in a form, and the request header needs to use Content-Type: application/x-www-form-urlencoded, please do not use other methods to submit data

Public parameters:

Private parameters:

Typesetting control label description: (For details, please refer to the SDK example)

<BR> : Line break
<CUT> : Cutter command (Active paper cutting, only valid for printers with cutting knives)
<LOGO> : Print LOGO command (Precondition: The logo has been set to the printer)
<PLUGIN> : Cash box or external audio instructions
<CB></CB> : Center to zoom in
<B></B> : Double the zoom
<C></C> : Centered
<L></L> : Double font height
<W></W> : Double font width
<QR></QR> : QR code (single order, only one QR code can be printed at most)
<RIGHT></RIGHT> : Align right
<BOLD></BOLD> : bold font
Print barcode (one-dimensional barcode) and order layout to align，
click to download the following function reference

Download Feie Cloud Barcode Function   

Download layout alignment function examples   

Download general examples of cloud printing 

If you have other technical questions, please join Feie API open platform 7 group: 945312990.
 

Return parameter description:

Return example:

correct:

  {
      "msg":"ok",
      "ret":0,
      "data":"816501678_20160919184316_1419533539",
      "serverExecutedTime":3
  }

error:

{
    "msg":"Parameter error: parameter value cannot pass null character",
    "ret":-2,
    "data":null,
    "serverExecutedTime":37
}

Label machine printing order, Open_printLabelMsg

Function description:

Send the order content that the user needs to print to the Feie Cloud label printer (this interface can only be used by the label machine, please do not use this interface for other printers)

Request URL:

http://api.jp.feieyun.com/Api/Open/

Request method:

POST (recommended), GET

pay attention:

1. The request written by the developer is submitted in a form. The request header needs to use Content-Type: application/x-www-form-urlencoded. If you need to print a picture, the request header needs to use Content-Type: multipart/form-data , Please do not submit data in other ways;
2. 1mm=8dots.

Public parameters:

Private parameters:

Typesetting control label description:

 Explanation of the x and y value parameters in the following tags:

                              
The values of x and y need to be taken according to the size of the paper actually used. For example, the size of the label paper is: width 40mm, height 30mm.
   1mm=8dots

                                    The maximum value of x is 40*8=320, and the value range of x is 0-320.

                                    The maximum value of y is 30*8=240, and the value range of y is 0-240.

<FEED> : paper feed
                                
<SIZE>width,height</SIZE> : 
set the width and height of the label paper, width label paper width (excluding backing paper), height label paper height (excluding backing paper), unit mm, such as <SIZE>30 ,20</SIZE>


                                
<GAP>m,n</GAP> : 
Set the vertical gap distance between two rolls of label paper, m the vertical distance between the two label papers 0≤m≤25.4(mm), n vertical gap offset n≤label paper Paper length, in mm, 
such as <GAP>7.62,-2.54</GAP>


                                
<DIRECTION>n</DIRECTION> : 
Set the direction of paper output and print fonts during printing, n 0 or 1, it will be initialized to 0 value setting every time the device is restarted, 1: forward paper output, 0: reverse output Paper, 
such as <DIRECTION>1</DIRECTION>


                                
<IMG x="10" y="100"> : To 
print a picture, it needs to be used in conjunction with the binary data of the uploaded img picture (one order can only be printed once), where the attribute x is the coordinate of the starting point in the horizontal direction (default is 0), 
Attribute y is the starting point coordinate in the vertical direction (default is 0)


                                
<QR x="10" y="100" e="L" w="5">QR code content</QR> : 
 Print the QR code, where the attribute x is the coordinate of the starting point in the horizontal direction (default is 0 ), the attribute y is the vertical starting point coordinate (default is 0), the attribute e is the error correction level: 
L 7%M 15%Q 25%H 30% (the default is K), the attribute w is the width of the QR code (default For 5)


                                
<TEXT x="10" y="100" font="12" w="2" h="2" r="0">Text content</TEXT> : 
 Print the text, where the attribute x starts from the horizontal direction The starting point coordinate (default is 0), the attribute y is the vertical starting point coordinate (default is 0), and the attribute font is the font:

1, 8×12 dot alphanumeric body 
2, 12×20 dot alphanumeric body 
3, 16×24 dot alphanumeric body 
4, 24×32 dot alphanumeric body 
5, 32×48 dot alphanumeric body 
6, 14×19 dot alphanumeric OCR-B 
7, 21×27 dot alphanumeric OCR-B 
8, 14×25 dot alphanumeric OCR-A 
9, 9×17 dot alphanumeric 
10, 12×24 dot alphanumeric 
11 , Traditional Chinese 24×24Font (big five code) 
12. Simplified Chinese 24×24Font (GB code) 
13. Korean 24×24Font (KS code) The 

default is 12 Simplified Chinese 24×24Font (GB code), the attribute w is the text width Magnification 1-10 (default is 1), attribute h is the height of the text, magnification 1-10 
attribute r is the rotation angle of the text (clockwise): 
0 0 degrees 
90 90 degrees 
180 180 degrees 
270 270 degrees
(The default is 0)


                                
<BC128 x="10" y="100" h="80" s="1" r="0" n="1" w="1">12345678</BC128>：
Print code128 one-dimensional code, Where the attribute x is the 
coordinate of the starting point in the horizontal direction (default is 0), the attribute y is the coordinate of the starting point in the vertical direction (the default is 0), whether the attribute s is readable by the human eye: 0 unrecognizable, 1 recognizable (default 1), 
The attribute n is the width of the narrow bar, expressed in dots (default is 1), the attribute w is the width of the wide bar (default is 1), expressed in dots, and the attribute r is the text rotation angle 
(clockwise): 
0 0 degrees 
90 90 degrees 
180 180 degrees 
270 270 degrees 
(default is 0)


                                
<BC39 x="10" y="100" h="80" s="1" r="0" n="1" w="1">12345678</BC39>：
Print code39 one-dimensional code, Where the attribute x is the 
coordinate of the starting point in the horizontal direction (the default is 0), the attribute y is the coordinate of the starting point in the vertical direction (the default is 0), whether the attribute s is readable by the human eye: 0 unrecognizable, 1 recognizable (default 1), The attribute 
n is the narrow bar width, expressed in dots (default is 1), the attribute w is the wide bar width (default is 2), expressed in dots, and the attribute r is the text rotation angle (clockwise 
direction): 
 0 0 degrees 
90 90 degrees 
180 180 degrees 
270 270 degrees 
(default is 0)


                                
<LOGO x="10" y="100"> :
Print LOGO command (provided that the LOGO picture is built in the machine in advance), where attribute x is the coordinate of the starting point in the horizontal direction (default is 0), and 
attribute y is the starting point in the vertical direction Coordinates (default is 0)
 To print an example of the order effect, click to download the following function reference. If you have other technical questions, please join the Fei Go API Open Platform 5 group: 146903613.

 Label Printing Machine Order example   Download
 

Return parameter description:

Return example:

correct:

  {
      "msg":"ok",
      "ret":0,
      "data":"816501678_20160919184316_1419533539",
      "serverExecutedTime":3
  }

error:

{
    "msg":"Parameter error: parameter value cannot pass null character",
    "ret":-2,
    "data":null,
    "serverExecutedTime":37
}

Delete batch printers, Open_printerDelList

Function description:

Delete batch printer

Request URL:

http://api.jp.feieyun.com/Api/Open/

Request method:

POST (recommended), GET

Public parameters:

Private parameters:

Return parameter description:

Return example:

correct:

  {"ok":["800000777success","915500104success"],"no":["800000777Verification failed: the printer number is illegal"]}

error:

{
    "msg":"Parameter error: parameter value cannot pass null character",
    "ret":-2,
    "data":null,
    "serverExecutedTime":37
}

Modify printer information, Open_printerEdit

Function description:

Modify printer information.

Request URL:

http://api.jp.feieyun.com/Api/Open/

Request method:

POST (recommended), GET

Public parameters:

Private parameters:

Return parameter description:

Return example:

correct:

{
    "msg":"ok",
    "ret":0,
    "data":true,
    "serverExecutedTime":9
}

error:

{
    "msg":"Parameter error: incorrect time format",
    "ret":1001,
    "data":null,
    "serverExecutedTime":37
}

Empty the queue to be printed, Open_delPrinterSqs

Function description:

Modify printer information.

Request URL:

http://api.jp.feieyun.com/Api/Open/

Request method:

POST (recommended), GET

Public parameters:

Private parameters:

Return parameter description:

Return example:

correct:

  {
  "msg":"ok",
  "ret":0,
  "data":true,
  "serverExecutedTime":9
  }

error:

{
    "msg":"Parameter error: incorrect time format",
    "ret":1001,
    "data":null,
    "serverExecutedTime":37
}

Query whether the order is printed successfully, Open_queryOrderState

Function description:

According to the order ID, to check whether the order is printed successfully, the order ID is returned by the interface Open_printMsg

Request URL:

http://api.jp.feieyun.com/Api/Open/

Request method:

POST (recommended), GET

Public parameters:

Private parameters:

Return parameter description:

Return example:

correct:

  {
      "msg":"ok",
      "ret":0,
      "data":true,
      "serverExecutedTime":2
  }

error:

{
    "msg":"Parameter error: parameter value cannot pass null character",
    "ret":-2,
    "data":null,
    "serverExecutedTime":37
}

Print status callback

1. Order status callback scenario description:

Interface provision Mode
The callback interface uses HTTPS POST, and the contentType is "Application/X-www-form-urlencoded". The service provider is required to configure the callback address whitelist in the developer background and submit the callback address when submitting the print order.

2. Message format:

2.1 Digital Signature Verification Description

2.1.1 Obtaining the Signature to Be verified Character String
Obtain all the post content of flying Goose cloud open platform, excluding byte type parameters, such as file, byte stream, eliminate the sign field, and eliminate the parameter whose value is empty; Sort by the ASCII key increment of the first character (alphabetically ascending), by the ASCII key increment of the second character if the same character is encountered, and so on; Combine the sorted parameters and their corresponding values into the format of parameter = parameter value, and use & At this time, the generated string is the signature segment to be tested, such as:
orderId：816501678_20160919184316_1419533539
status：1 stime：1625194910 The signature paragraph to be examined is：orderId=816501678_20160919184316_1419533539&status=1&stime=1625194910

2.1.2 Obtaining the signature value sign
NW1BNm4oTxyyPBdXHPwuI5gjh2onvyHavrSLnrPAGCp4TnoX1IJTwwX+tXFybdi+bo+OM/1FoIeU4H70fPw0m/z/Fz6EYdDpsBbUZFbbUdj9OJrzY/sdnArkynnYoVkLGOwV0DM1WvCn3iqlskD5O1K6POFDc0006xMK+d3/SSNegSUPMuIvuXG6VKGiDN0rO9hOdXFjrp0b1Td14ofPXKibmGXV7XikC2suU45nWmCBC8lKzhazCiInS/tkRAF8WsS2AiACeMvmonyrT/LZWbsfrd9k6M+kATCOz7EjPEd9z+W8N8Rtbur1m3MZdjAshMfduqQEpRU+w7U6R4sxQA==

2.1.3 Decode signature parameter (sign) into signature value bytecode string using Base64

2.1.4 SHA256WithRSA is used to verify the signature value using the public key of the Flying Goose Cloud, signature string to be verified, and signature value bytecode string.

2.2 Flying Goose Cloud Public Key

Click download attachment

3 Response Format

Return example:

SUCCESS

Query the order statistics of the specified printer for a certain day, Open_queryOrderInfoByDate

Function description:

Query the order details of the specified printer for a certain day, and return the number of printed orders and the number of waiting to be printed.

Request URL:

http://api.jp.feieyun.com/Api/Open/

Request method:

POST (recommended), GET

Public parameters:

Private parameters:

Return parameter description:

Return example:

correct:

  {
  "msg":"ok",
  "ret":0,
  "data":{"print":6,"waiting":1},
  "serverExecutedTime":9
  }

error:

{
    "msg":"Parameter error: incorrect time format",
    "ret":1001,
    "data":null,
    "serverExecutedTime":37
}

Get the status of a printer, Open_queryPrinterStatus

Function description:

Query the status of the specified printer, and return the online or offline, normal or abnormal information of the printer.

Request URL:

http://api.jp.feieyun.com/Api/Open/

Request method:

POST (recommended), GET

Public parameters:

Private parameters:

Return parameter description:

Return example:

correct:

  {
  "msg":"ok",
  "ret":0,
  "data":"The online working condition is normal",
  "serverExecutedTime":9
  }

error:

{
    "msg":"Parameter error: incorrect time format",
    "ret":1001,
    "data":null,
    "serverExecutedTime":37
}

Public parameter exception

Add printer interface

Print order interface

Delete printer interface

Modify printer information interface

Clear the print queue interface

Interface to query whether the order is printed successfully

Query the printer's order statistics interface for a certain day

Query printer status interface