Authentication and API Keys
PDFCrowd services require authentication. Personal credentials are associated with your account; demo credentials are available for evaluation without registration.
Getting a Key
Personal keys are created in your PDFCrowd account on the API Keys, WebSave Keys, or WordPress Keys page. An active trial or paid license is required.
A free trial provides test credits for evaluation. It is available through registration. Current terms are listed under plans and trial details.
Many documentation examples are prefilled with demo credentials or your personal credentials when available. You can copy the code and adjust input URLs, file paths, and output settings as needed.
API Keys
API keys authenticate HTTP API requests, SDKs, command-line tools, and automation integrations. Authentication requires both the PDFCrowd username and an API key. Keys are created and managed on the account's API Keys page.
Demo credentials use demo as both the username and API key and
are for evaluation only.
Demo conversions have usage limits and may include demo branding in the output.
HTTP API
The HTTP API uses Basic authentication over HTTPS. Configure your HTTP
client's Basic authentication method with your PDFCrowd username as the
username and your API key as the password. In cURL, the credentials are set
with -u "username:apiKey".
The client joins the username and API key as
username:apiKey and Base64-encodes the result. It sends this
value in the Authorization header as
Basic <encoded-credentials>.
SDKs
SDK clients receive the
username and API key at initialization, in the form
Client(username, apiKey), and handle HTTP authentication.
All converter clients use this authentication pattern.
Automation Integrations
Automation integrations accept the PDFCrowd username and API key in their PDFCrowd connection settings.
WebSave Keys
WebSave keys authenticate WebSave as PDF and WebSave as Image buttons. Keys are created and managed on the account's WebSave Keys page.
The key is set in the button's data-key attribute. No username is
required. The key demo is available for evaluation only.
Personal keys are scoped to the domain or subdomain specified when they are created. The Include subdomains setting extends this scope to sites beneath that hostname.
WordPress Keys
WordPress keys authenticate PDFCrowd's Save as PDF and Save as Image plugins. Keys are created and managed on the account's WordPress Keys page.
Personal credentials are set on the plugin's License tab with Commercial selected as the license type:
- Username: the PDFCrowd account username.
- API Key: the WordPress key from that account.
The plugins' built-in demo mode requires no credentials and is available for evaluation only.