HTML to Image Conversion

Introduction

Aspose.HTML Cloud has provided an API to convert HTML page to the raster image format (JPEG, PNG, BMP or TIFF). You can convert the HTML document either from the storage by its name or from the web by its URL to the specified image format.

The outFormat parameter value could be one of the following:

jpeg
bmp
png
tiff

API Information

API	Type	Description	Swagger Link
/html/{name}/convert/image/{outFormat}	GET	Converts the HTML document (located on storage) to the specified image format and returns resulting file in response content	GetConvertDocumentToImage
/html/{name}/convert/image/{outFormat}	PUT	Converts the HTML document (located on storage) to the specified image format and uploads resulting file to storage.	PutConvertDocumentToImage
/html/convert/image/{outFormat}	GET	Converts the HTML page (located in the Web) to the specified image format and returns resulting file in response content	GetConvertDocumentToImageByUrl
/html/convert/image/{outFormat}	POST	Converts the HTML document (in request content) to the specified image format and uploads resulting file to storage	PostConvertDocumentInRequestToImage

cURL Example

Please examine the HTTP Response code for success verification.

Case 1: Converts the HTML document (located on storage) to the specified image format and returns resulting file in response content:

Request


curl -v "https://api.aspose.cloud/oauth2/token" -X POST -d "grant_type=client_credentials&client_id=XXXXX&client_secret=XXXXX" -H "Content-Type: application/x-www-form-urlencoded" -H "Accept: application/json"


curl -v "https://api.aspose.cloud/v3.0/html/test.html/convert/image/jpeg" -X GET  -H "Accept: application/json"

Case 2: Converts the HTML document (located on storage) to the specified image format and uploads resulting file to storage:

Request


curl -v "https://api.aspose.cloud/oauth2/token" -X POST -d "grant_type=client_credentials&client_id=XXXXX&client_secret=XXXXX" -H "Content-Type: application/x-www-form-urlencoded" -H "Accept: application/json"


curl -v "https://api.aspose.cloud/v3.0/html/test.html/convert/image/jpeg?outpath=test.jpeg" -X PUT  -H "Accept: application/json"

Case 3: Converts the HTML page (located in the Web) to the specified image format and returns resulting file in response content:

Request


curl -v "https://api.aspose.cloud/oauth2/token" -X POST -d "grant_type=client_credentials&client_id=XXXXX&client_secret=XXXXX" -H "Content-Type: application/x-www-form-urlencoded" -H "Accept: application/json"


curl -v "https://api.aspose.cloud/v3.0/html/test.html/convert/image/jpeg?sourceURL=http://help.websiteos.com/websiteos/example_of_a_simple_html_page.htm" -X GET  -H "Accept: application/json"

Case 4: Converts the HTML document (in request content) to the specified image format and uploads resulting file to storage:

Request


curl -v "https://api.aspose.cloud/oauth2/token" -X POST -d "grant_type=client_credentials&client_id=XXXXX&client_secret=XXXXX" -H "Content-Type: application/x-www-form-urlencoded" -H "Accept: application/json"


curl -v "https://api.aspose.cloud/v3.0/html/convert/image/jpeg?outpath=a345.jpeg" -X POST -F "file=@test.html" -H "Accept: multipart/form-data"

Available 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 Aspose.HTML SDKs along with working examples, to get you started in no time. Please check Available SDKs article to learn how to add an SDK to your project.

SDK Examples

Case 1: Convert the HTML document from the storage by its name to the specified image format

HTML to XPS Conversion HTML conversion to Markdown