Documentation

Pre-preparation

To start developing, you need to request the server address and all file tool types currently supported, and then select the corresponding function according to your needs.

Request server list

This interface is used to obtain the server list. You can retrieve the server region and server address.

Request method

  • request method: GET
  • parameter transfer method: Query

Request address

https://api-cn-east-1.17pdf.com/server/v1/server/all

Return parameter

parameter name data type description
serverName String server location
serverUrl String server address url
"code": "200",
"msg": "success",
"data": {
    "serverName": "zh_CN",
    "serverUrl": "api-cn-east-1.17pdf.com"
}

Request PDF tool list

This interface is used to obtain the collection of all PDF tools supported by the ComPDFKit API, and you can query the URL of each PDF tool.

Request method

  • request method: GET
  • parameter transfer method: Query

Request address

https://api-cn-east-1.17pdf.com/server/v1/tool/support

Return parameter

parameter name data type description
sourceTypeName String Source file format
targetTypeName String Destination file format
executeTypeUrl String Type of execution task
"code": "200",
"msg": "success",
"data": {
    {
        "sourceTypeName": "pdf",
        "targetTypeName": "docx",
        "executeTypeUrl": "pdf/docx"
    },
    {
        "sourceTypeName": "pdf",
        "targetTypeName": "jpg",
        "executeTypeUrl": "pdf/jpg"
    },
    {
        "sourceTypeName": "doc",
        "targetTypeName": "pdf",
        "executeTypeUrl": "doc/pdf"
    }
    ......
}