NAV
Shell HTTP JS PHP C# Java

PDF from HTML generator REST API v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

API to generate PDF file from provided HTML source.

Conversion

Convert HTML to PDF

Code samples

# You can also use wget
curl -X POST /service/pdf-generator/Conversion/htmlToPdf \
  -H 'Content-Type: text/html' \
  -H 'name: string' \
  -H 'headerId: string' \
  -H 'footerId: string' \
  -H 'api-version: string'


POST /service/pdf-generator/Conversion/htmlToPdf HTTP/1.1

Content-Type: text/html

name: string
headerId: string
footerId: string
api-version: string


const inputBody = 'string';
const headers = {
  'Content-Type':'text/html',
  'name':'string',
  'headerId':'string',
  'footerId':'string',
  'api-version':'string'
};

fetch('/service/pdf-generator/Conversion/htmlToPdf',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'text/html',
    'name' => 'string',
    'headerId' => 'string',
    'footerId' => 'string',
    'api-version' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/service/pdf-generator/Conversion/htmlToPdf', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/service/pdf-generator/Conversion/htmlToPdf";


      await PostAsync(null, url);

    }

    /// Performs a POST Request
    public async Task PostAsync(undefined content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(undefined content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}


URL obj = new URL("/service/pdf-generator/Conversion/htmlToPdf");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /service/pdf-generator/Conversion/htmlToPdf

Sample request:

curl --location --request POST 'https://.../api/conversion/htmlToPdf' \ --header 'name: Test.pdf' \ --header 'headerId: test' \ --header 'footerId: test' \ --header 'Content-Type: text/html' \ --data-raw ' ... '

Body parameter

string

Parameters

Name In Type Required Description
name header string true Test.pdf
headerId header string false test
footerId header string false test
api-version query string false none
api-version header string false none
body body string true Content: <html>...</html>

Responses

Status Meaning Description Schema
204 No Content Success None

Health

Default endpoint called on application start

Code samples

# You can also use wget
curl -X GET /service/pdf-generator/Health/status \
  -H 'Accept: text/plain' \
  -H 'api-version: string'


GET /service/pdf-generator/Health/status HTTP/1.1

Accept: text/plain
api-version: string



const headers = {
  'Accept':'text/plain',
  'api-version':'string'
};

fetch('/service/pdf-generator/Health/status',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'api-version' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/service/pdf-generator/Health/status', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/service/pdf-generator/Health/status";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}


URL obj = new URL("/service/pdf-generator/Health/status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /service/pdf-generator/Health/status

Sample request:

curl --location --request POST 'https://.../api/health/status' \

Parameters

Name In Type Required Description
api-version query string false none
api-version header string false none

Example responses

200 Response

true

true

Responses

Status Meaning Description Schema
200 OK Success boolean

Template

List Templates

Code samples

# You can also use wget
curl -X GET /service/pdf-generator/Template/list \
  -H 'api-version: string'


GET /service/pdf-generator/Template/list HTTP/1.1

api-version: string



const headers = {
  'api-version':'string'
};

fetch('/service/pdf-generator/Template/list',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


<?php

require 'vendor/autoload.php';

$headers = array(
    'api-version' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/service/pdf-generator/Template/list', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/service/pdf-generator/Template/list";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}


URL obj = new URL("/service/pdf-generator/Template/list");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /service/pdf-generator/Template/list

Sample request:

curl --location --request GET 'https://.../api/template/list' \ --header 'Content-Type: text/html' \

Parameters

Name In Type Required Description
api-version query string false none
api-version header string false none

Responses

Status Meaning Description Schema
200 OK Success None

Get Template

Code samples

# You can also use wget
curl -X GET /service/pdf-generator/Template/get \
  -H 'id: string' \
  -H 'api-version: string'


GET /service/pdf-generator/Template/get HTTP/1.1

id: string
api-version: string



const headers = {
  'id':'string',
  'api-version':'string'
};

fetch('/service/pdf-generator/Template/get',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


<?php

require 'vendor/autoload.php';

$headers = array(
    'id' => 'string',
    'api-version' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/service/pdf-generator/Template/get', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/service/pdf-generator/Template/get";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}


URL obj = new URL("/service/pdf-generator/Template/get");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /service/pdf-generator/Template/get

Sample request:

curl --location --request GET 'https://.../api/template/get' \ --header 'id: test' \ --header 'Content-Type: text/html' \

Parameters

Name In Type Required Description
id header string true none
api-version query string false none
api-version header string false none

Responses

Status Meaning Description Schema
200 OK Success None

Create Template

Code samples

# You can also use wget
curl -X POST /service/pdf-generator/Template/upload \
  -H 'Content-Type: text/html' \
  -H 'id: string' \
  -H 'api-version: string'


POST /service/pdf-generator/Template/upload HTTP/1.1

Content-Type: text/html

id: string
api-version: string


const inputBody = 'string';
const headers = {
  'Content-Type':'text/html',
  'id':'string',
  'api-version':'string'
};

fetch('/service/pdf-generator/Template/upload',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'text/html',
    'id' => 'string',
    'api-version' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/service/pdf-generator/Template/upload', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/service/pdf-generator/Template/upload";


      await PostAsync(null, url);

    }

    /// Performs a POST Request
    public async Task PostAsync(undefined content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(undefined content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}


URL obj = new URL("/service/pdf-generator/Template/upload");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /service/pdf-generator/Template/upload

Sample request:

curl --location --request POST 'https://.../api/template/upload' \ --header 'id: test' \ --header 'Content-Type: text/html' \ --data-raw ' header '

Body parameter

string

Parameters

Name In Type Required Description
id header string true Template ID
api-version query string false none
api-version header string false none
body body string true Content: <html>header</html>

Responses

Status Meaning Description Schema
200 OK Success None

Update Template

Code samples

# You can also use wget
curl -X PUT /service/pdf-generator/Template/update \
  -H 'Content-Type: text/html' \
  -H 'id: string' \
  -H 'api-version: string'


PUT /service/pdf-generator/Template/update HTTP/1.1

Content-Type: text/html

id: string
api-version: string


const inputBody = 'string';
const headers = {
  'Content-Type':'text/html',
  'id':'string',
  'api-version':'string'
};

fetch('/service/pdf-generator/Template/update',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'text/html',
    'id' => 'string',
    'api-version' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/service/pdf-generator/Template/update', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }



    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/service/pdf-generator/Template/update";



      var result = await PutAsync(id, null, url);

    }

    /// Performs a PUT Request
    public async Task PutAsync(int id, undefined content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);

        //Return response
        return await DeserializeObject(response);
    }


    /// Serialize an object to Json
    private StringContent SerializeObject(undefined content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}


URL obj = new URL("/service/pdf-generator/Template/update");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PUT /service/pdf-generator/Template/update

Sample request:

curl --location --request PUT 'https://.../api/template/update' \ --header 'id: test' \ --header 'Content-Type: text/html' \ --data-raw ' header '

Body parameter

string

Parameters

Name In Type Required Description
id header string true Template ID
api-version query string false none
api-version header string false none
body body string true Content: <html>header</html>

Responses

Status Meaning Description Schema
200 OK Success None

Delete Template

Code samples

# You can also use wget
curl -X DELETE /service/pdf-generator/Template/removeHeader \
  -H 'id: string' \
  -H 'api-version: string'


DELETE /service/pdf-generator/Template/removeHeader HTTP/1.1

id: string
api-version: string



const headers = {
  'id':'string',
  'api-version':'string'
};

fetch('/service/pdf-generator/Template/removeHeader',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


<?php

require 'vendor/autoload.php';

$headers = array(
    'id' => 'string',
    'api-version' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/service/pdf-generator/Template/removeHeader', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }




    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/service/pdf-generator/Template/removeHeader";

      await DeleteAsync(id, url);
    }

    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");

        //Return response
        await DeserializeObject(response);
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}


URL obj = new URL("/service/pdf-generator/Template/removeHeader");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /service/pdf-generator/Template/removeHeader

Sample request:

curl --location --request DELETE 'https://.../api/template/remove' \ --header 'id: test' \ --header 'Content-Type: text/html' \

Parameters

Name In Type Required Description
id header string true Template ID
api-version query string false none
api-version header string false none

Responses

Status Meaning Description Schema
200 OK Success None
Shell HTTP JS PHP C# Java