URLConverter Parameters

The "URLConverter" web service van be used to convert URL resources (websites) to a PDF document.

 

hint

Please keep in mind the limitations of HTML conversion.

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<operation xmlns="http://schema.webpdf.de/1.0/operation">
<urlconverter url="https://www.webpdf.de/">
  <page bottom="20"
        height="297"
        left="20"
        right="20"
        metrics="mm"
        top="20"
        width="210"/>
  <basicAuth password=""
              userName=""/>
  <proxy userName=""
          password=""
          address=""
          port="0"/>
</urlconverter>
</operation>

{
"urlconverter": {
  "url": "https://www.webpdf.de/",
  "page": {
    "bottom": 20,
    "height": 297,
    "left": 20,
    "right": 20,
    "metrics": "mm",
    "top": 20,
    "width": 210
   },
  "basicAuth": {
    "password": "",
    "userName": ""
   },
  "proxy": {
    "password": "",
    "userName": "",
    "address": "",
    "port": 0
   }
 }
}

 

urlconverter element

 

Used to define the URL resource that should be converted.

 

<urlconverter url="https://www.webpdf.de/">
...
</urlconverter>
 

"urlconverter": {
"url": "https://www.webpdf.de/",

 ...
}

 

url (default: "")

The URL for the resource to be converted.

 

page element

 

This element is used to specify the size of the page in the PDF document.

 

<page bottom="20"
    height="297"
    left="20"
    right="20"
    metrics="mm"
    top="20"
    width="210"/>

"page": {
  "bottom": 20,
  "height": 297,
  "left": 20,
  "right": 20,
  "metrics": "mm",
  "top": 20,
  "width": 210
},

 

bottom (default: 20)

top (default: 20)

left (default: 20)

right (default: 20)

Margin settings (in millimetres) for the output in PDF format.

 

height (default: 297)

Paper height (in millimetres) for the output in PDF format.

 

width (default: 210)

Paper width (in millimetres) for the output in PDF format.

 

metrics (default: "mm")

Unit for the arguments. As of this writing, the only option is "mm."

 

basicAuth element

 

Used to define the appropriate login information if access to the resource requires a login using the "Basic Authentication" method.

 

<basicAuth password=""
          userName=""/>

"basicAuth": {
"password": "",
"userName": ""
},

 

password (default: "")

Password if the URL requests an authentication of the "Basic Authentication" type.

 

userName (default: "")

Username if the URL requests an authentication of the "Basic Authentication" type.

 

proxy element

 

Used to define the proxy and the access information if the resource must be fetched through a proxy.

 

<proxy userName=""
      password=""
      address=""
      port="0"/>

"proxy": {
  "password": "",
  "userName": "",
  "address": "",
  "port": 0
}

 

password (default: "")

Password if access to the proxy service requires authentication.

 

userName (default: "")

Username if access to the proxy service requires authentication.

 

address (default: "")

The address at which the proxy server can be reached.

 

port (default: 0)

The port that should be used to access the proxy server.