Skip to content

API Convert

damiancosmoschapman edited this page Oct 4, 2021 · 16 revisions

Home / API / Convert JSON-RPC

This page contains the JSON-RPC versions of the Convert method. For the RESTful method, please go to the RESTful page for Convert.

Create a PDF file from a CSO domain URL.

Returns a base64 PDF string

Authentication: Anonymous

Privilege : N/A

Method: PxStat.Data.Cube_API.Create

Parameters:

Name Type Default Description
urls String null or empty URL to convert to PDF
chromeCommandLineOptions Array[String] null or empty Chrome Command Line Options
printOptions JSON Object null or empty Print options

Return: json

The Json format follow the JSON-Stat schema. Please refer to JSON-stat documentation. An example is shown below:

{
   "jsonrpc":"2.0",
   "method":"PDFapi.Data.Convert_API.Create",
   "params":{
      "urls": [ "https://data.cso.ie" ],
      "chromeCommandLineOptions":[
         "headless",
         "disable-gpu",
         "run-all-compositor-stages-before-draw"
      ],
      "printOptions":{
         "paperWidth":8.3,
         "paperHeight":11.7,
         "scale":1.0,
         "pageRanges":"1"
      },
    "returnType":"base64String"
   },
   "id": 123
}
Clone this wiki locally