Convert Webpage to PDF API
ApyHub
50 atoms
Base tier
About
The Webpage to PDF conversion API lets you easily convert URLs into PDF documents, preserving the exact visual appearance of the original webpage.
By using the HTML to PDF conversion API, you benefit from a seamless sharing and document distribution process, ensuring that the formatting, fonts, and layouts are consistent across different devices and software. Moreover, the Webpage to PDF API supports enhanced security features, such as password protection and encryption, to secure sensitive information when distributing PDF files.
Try out the Webpage to PDF API in the API playground and reduce conversion errors with a simple API call.
Select API Endpoints
Output
API Playground
API Documentation
webpage url: download pdf file
POST
https://api.apyhub.com/generate/webpage/pdf-file
Request example
Method:
POST
Content Type:
application/json
Query Parameter(s)
Attribute | Type | Mandatory | Description |
---|---|---|---|
landscape | Boolean | No | Indicates whether the pdf file needs to be generated in a landscape mode (default is false ) |
margin | Decimal | No | Indicates the margins for the converted webpage (recommended values between 0 to 1 & default is 0.1 ) |
output | String | No | The PDF file name for the converted html content. If no output attribute is provided, the default file name will be output.pdf |
Request Body
Attribute | Type | Mandatory | Description |
---|---|---|---|
url | String | Yes | The webpage url |
Sample Response
A successful request returns the PDF file in the output parameter specified. If the request fails, the response contains an error code and a message to help determine what went wrong.
HTTP Response Codes
The method may return one of the following HTTP status codes:
Status Code | Description |
---|---|
200 | The request was successful. |
401 | Required authentication information is either missing or not valid for the resource. |
400 | Invalid input - the url was empty or inaccessible |
500 | If any unexpected error occurs while processing the request |
Authentication
All API requests to ApyHub services need to be authenticated. Currently we support
tokens
or basic authentication
mechanisms.
You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".Points to note:
- Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
- Use the
apy-token
as the header parameter to pass the token. - Use the
Authorization
header to send the basic authentication credentials.
Error codes
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents