10. Convert Html document with load options

Introduction

This example demonstrates how to convert html document into pdf document with load options.

There are steps that usage of GroupDocs.Conversion Cloud consists of:

  1. Upload input document into cloud storage
  2. Convert document
  3. Download converted document from storage

Steps 1 and 3 are storage operations, please refer to the [File API documentation»path:/conversioncloud/developer-guide/working-with-file-api/) for usage details.

Step 3 is not needed, if “OutputPath” option is not provided: the convert api method will return converted document in the response body

Resource URI

HTTP POST https://api.groupdocs.cloud/v2.0/conversion/conversion

Swagger UI lets you call this REST API directly from the browser.

cURL Example


* First get JSON Web Token
* Please get your App Key and App SID from https://dashboard.groupdocs.cloud/#/apps. Kindly place App Key in "client_secret" and App SID in "client_id" argument.
curl -v "https://api.groupdocs.cloud/connect/token" \
-X POST \
-d "grant_type#client_credentials&client_id#xxxx&client_secret#xxxx" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Accept: application/json"

* cURL example to convert document
curl -v "https://api.groupdocs.cloud/v2.0/conversion/conversion" \
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>"
-d "{
        'FilePath': 'Html/sample.html',
        'Format': 'pdf',
        'LoadOptions': {
            'PageNumbering': true
        },
        'OutputPath': 'Output'
    }"


[
  {
    "name": "sample.pdf",
    "size": 20072,
    "path": "Output/sample.pdf",
    "url": "https://api.groupdocs.cloud/v2.0/conversion/storage/file/Output/sample.pdf"
  }
]

SDKs

Using an SDK (API client) is the quickest way for a developer to speed up the development. An SDK takes care of a lot of low-level details of making requests and handling responses and lets you focus on writing code specific to your particular project. Check out our GitHub repository for a complete list of GroupDocs.Conversion Cloud SDKs along with working examples, to get you started in no time. Please check [Available SDKs»path:/conversioncloud/getting-started/available-sdks/) article to learn how to add an SDK to your project.


* For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-dotnet-samples
string MyAppKey = ""; * Get AppKey and AppSID from https://dashboard.groupdocs.cloud
string MyAppSid = ""; * Get AppKey and AppSID from https://dashboard.groupdocs.cloud

var configuration = new Configuration(MyAppSid, MyAppKey);

* Create necessary API instances
var apiInstance = new ConvertApi(configuration);

* Prepare convert settings
var settings = new ConvertSettings
{
    StorageName = Constants.MyStorage,
    FilePath = "Html/sample.html",
    Format = "pdf",
    LoadOptions = new HtmlLoadOptions
    {
        PageNumbering = true
    },
    OutputPath = "converted"
};

* Convert to specified format
var response = apiInstance.ConvertDocument(new ConvertDocumentRequest(settings));


* For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-java-samples
String MyAppKey = ""; * Get AppKey and AppSID from https://dashboard.groupdocs.cloud
String MyAppSid = ""; * Get AppKey and AppSID from https://dashboard.groupdocs.cloud

Configuration configuration = new Configuration(MyAppSid, MyAppKey);

* Create API instance
ConvertApi apiInstance = new ConvertApi(configuration);

* Prepare convert settings
ConvertSettings settings = new ConvertSettings();
settings.setFilePath("Html/sample.html");
settings.setFormat("pdf");

HtmlLoadOptions loadOptions = new HtmlLoadOptions();
loadOptions.setPageNumbering(true);

settings.setLoadOptions(loadOptions);
settings.setOutputPath("converted");

List<StoredConvertedResult> result = apiInstance.convertDocument(new ConvertDocumentRequest(settings));


* For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-php-samples
use GroupDocs\Conversion\Model;
use GroupDocs\Conversion\Model\Requests;

$AppSid = ""; * Get AppKey and AppSID from https://dashboard.groupdocs.cloud
$AppKey = ""; * Get AppKey and AppSID from https://dashboard.groupdocs.cloud

$configuration = new GroupDocs\Conversion\Configuration();
$configuration->setAppSid($AppSid);
$configuration->setAppKey($AppKey);

$apiInstance = new GroupDocs\Conversion\ConvertApi($configuration);

* Prepare convert settings
$settings = new Model\ConvertSettings();
$settings->setStorageName(Utils::$MyStorage);
$settings->setFilePath("Html/sample.html");
$settings->setFormat("pdf");

$loadOptions = new Model\HtmlLoadOptions();
$loadOptions->setPageNumbering(true);

$settings->setLoadOptions($loadOptions);
$settings->setOutputPath("converted");

* Convert
$result = $apiInstance->convertDocument(new Requests\ConvertDocumentRequest($settings));


* For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-node-samples
global.conversion_cloud = require("groupdocs-conversion-cloud");

global.appSid = "XXXX-XXXX-XXXX-XXXX"; * Get AppKey and AppSID from https://dashboard.groupdocs.cloud
global.appKey = "XXXXXXXXXXXXXXXX"; * Get AppKey and AppSID from https://dashboard.groupdocs.cloud

global.convertApi = conversion_cloud.ConvertApi.fromKeys(appSid, appKey);

let settings = new conversion_cloud.ConvertSettings();
settings.filePath = "Html/sample.html";
settings.format = "pdf";

let loadOptions = new conversion_cloud.HtmlLoadOptions();
loadOptions.pageNumbering = true;

settings.loadOptions = loadOptions;
settings.outputPath = "converted";

let result = await convertApi.convertDocument(new conversion_cloud.ConvertDocumentRequest(settings));


# For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-python-samples
import groupdocs_conversion_cloud

app_sid = "XXXX-XXXX-XXXX-XXXX" = Get AppKey and AppSID from https://dashboard.groupdocs.cloud
app_key = "XXXXXXXXXXXXXXXX" = Get AppKey and AppSID from https://dashboard.groupdocs.cloud

# Create necessary API instances
apiInstance = groupdocs_conversion_cloud.ConvertApi.from_keys(Common.app_sid, Common.app_key)

# Prepare convert settings
settings = groupdocs_conversion_cloud.ConvertSettings()
settings.file_path = "Html/sample.html"
settings.format = "pdf"

loadOptions = groupdocs_conversion_cloud.HtmlLoadOptions()
loadOptions.page_numbering = True

settings.load_options = loadOptions
settings.output_path = "converted"

# Convert
result = apiInstance.convert_document(groupdocs_conversion_cloud.ConvertDocumentRequest(settings))


# For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-ruby-samples
require 'groupdocs_conversion_cloud'

$app_sid = "XXXX-XXXX-XXXX-XXXX" = Get AppKey and AppSID from https://dashboard.groupdocs.cloud
$app_key = "XXXXXXXXXXXXXXXX" = Get AppKey and AppSID from https://dashboard.groupdocs.cloud

# Create necessary API instances
apiInstance = GroupDocsConversionCloud::ConvertApi.from_keys($app_sid, $app_key)

# Prepare convert settings
settings = GroupDocsConversionCloud::ConvertSettings.new
settings.file_path = "Html/sample.html"
settings.format = "pdf"

loadOptions = GroupDocsConversionCloud::HtmlLoadOptions.new
loadOptions.page_numbering = true

settings.load_options = loadOptions
settings.output_path = "converted"

# Convert
result = apiInstance.convert_document(GroupDocsConversionCloud::ConvertDocumentRequest.new(settings))