API Documentation
Services are accessible using a REST API. Use the following host address:
http://pws.servepdf.com
Payed Services
| Service | Parameters | Description |
| POST /process |
instance of the PDFData XSD Schema |
Performs the merging of data with the PDF form.
The service responds with the resulting PDF Document. |
| POST /rss |
formURL,feedURL parameter descriptions |
Reads the form using the provided formURL.
Reads syndication feed entries from the provided feedURL.
The service responds with a combined PDF Document containing all feed entries. |
Free Services
| Service | Parameters | Description |
| GET /sample |
formURL |
Reads the Form using the provided formURL.
The service responds with a sample instance of PDFData om XML.
It can be used to verify all input data fields for your Form.
|
| POST /sample |
PDF Form |
Provide the Form by uploading a PDF document.
The service responds with a sample instance of PDFData.
It can be used to verify all input data fields for your Form.
|
| GET /test |
formURL |
Reads the Form using the provided formURL.
The service responds with a test page to fill all the fields from the Form.
Submitting the HTML Form from the test page will process it and a PDF document is returned.
|
| POST /feedshot |
feedURL |
Same as the payed "/rss" service but with limited parameter support.
If the feedURL parameter is not provided, then read the referring HTML page to detect a reference to an RSS feed. |
| GET /feedshot |
feedURL |
Same as the GET "/feedshot" service. Can be used for direct links.
|
pdfdata.head child elements
| Element | Required | Description |
| access-key |
yes |
identifier provided by ServePDF.com after registration |
| application-key |
no |
optional identifier provided by your application.
This value can be used to filter reporting results in the ServePDF Dashboard |
| cache-control |
no |
applies to Form caching only. Allowed values are
- no-cache (default)
- cache-assets
- cache-for-session
|
| auto-print |
no |
optional features that instructs the PDF Reader to automatically start its Print function |
| unserviceable-url |
no |
If for some reason the service could not be completed successfully,
the Internet Browser can be redirected using this URL.
Parameters are passed in with details about the failure. |
pdfdata.body child elements
| Element | Description |
| contents |
collection of content elements |
pdfdata.body.content child elements
| Element | Description |
| form-url |
reference to the PDF Form. Supported schemes are http and https. |
| fields |
collection of field elements |
pdfdata.body.fields child elements
| Element | Description |
| field |
Attributes:
- name = required, non-empty unique (within the Form) identifier of a TextField.
- value = the identified TextField on the Form will be replaced by this value
|
RSS
| Parameter | Required | Description |
| formURL |
yes |
Location of the PDF Form containing fields for a single entry. |
| feedURL |
yes |
Location of the RSS feed. Supported formats are (0.90, 0.91, 0.92, 0.93, 0.94, 1.0 and 2.0) |
| maxEntries |
no |
Limits the number of feed entries in the PDF document. |
| descriptionsOnly |
no |
Force to create a document with descriptions only instead of the full article content as available by the feed entry. |
| unserviceableURL |
no |
If for some reason the feed could not be read or processed, the user is redirected to this URL.
The service will pass error information as request query parameters. |
For each entry in the RSS feed, a PDFData object is created.
Textfields of that object are initialized using information from the entry.
PDF Form can use the following fields.
| Textfield | Description |
| title |
the title for the entry |
| author |
name of the author of the entry |
| publishedDate |
date on which the entry was published |
| updatedDate |
last modified date of the entry |
| link |
the URL of the article referred to by the entry |
| uri |
the URL of the feed? |
| authors |
comma separated line of authors names |
| categories |
comma separated line of category names |
| contributors |
comma separated line of contributor names |