2019.1
Table Of Contents
- Table of Contents
- Welcome to the PlanetPress Connect REST API Cookbook
- Technical Overview
- Working Examples
- Getting Started
- Server Security & Authentication
- Working with the File Store
- Working with the Entity Services
- Working with the Workflow Services
- Running a Data Mapping Operation
- Running a Data Mapping Operation (Using JSON)
- Running a Data Mapping Operation for PDF/VT File (to Data Set)
- Running a Data Mapping Operation for PDF/VT File (to Content Set)
- Running a Content Creation Operation for Print
- Running a Content Creation Operation for Print By Data Record (Using JSON)
- Running a Content Creation Operation for Email By Data Record (Using JSON)
- Creating Content for Web By Data Record
- Creating Content for Web By Data Record (Using JSON)
- Running a Job Creation Operation (Using JSON)
- Running an Output Creation Operation
- Running an Output Creation Operation (Using JSON)
- Running an Output Creation Operation By Job (Using JSON)
- Running an All-In-One Operation (Using JSON)
- REST API Reference
- Authentication Service
- Content Creation Service
- Service Handshake
- Process Content Creation
- Process Content Creation (By Data Record) (JSON)
- Process Content Creation (By Data) (JSON)
- Create Preview PDF
- Create Preview PDF (By Data Record)
- Create Preview PDF (By Data) (JSON)
- Get All Operations
- Get Progress of Operation
- Get Result of Operation
- Cancel an Operation
- Service Version
- Content Item Entity Service
- Content Set Entity Service
- Data Record Entity Service
- Data Set Entity Service
- Data Mapping Service
- Document Entity Service
- Document Set Entity Service
- Content Creation (Email) Service
- Entity Service
- File Store Service
- Content Creation (HTML) Service
- Job Creation Service
- Job Entity Service
- Job Segment Entity Service
- Job Set Entity Service
- Output Creation Service
- All-In-One Service
- Copyright Information
- Legal Notices and Acknowledgements
Authenticate/Login to Server
Submits an authentication request (using credentials) to the PlanetPress Connect server and if
successful provides access to the various other REST API services available.
Request takes no content, but requires an additional Authorization header which contains a
base64 encoded set of credentials (basic user name & password). On success, the response
with return an authorization token which can then be used as an additional auth_token header
in any future requests made to the REST API services.
Warning
If server security settings are enabled and a request is made to any resource of any
service in the REST API, if that request contains no authorization token and no
Authorization header, then the response will come back as Unauthorized and will contain
an additional WWW-Authenticate response header.
Type: POST
URI:
/rest/serverengine/authentication/login
Parameters: –
Request:
Add.
Headers:
Authorization – Basic User name & Password
credentials (Base64 encoded)
Content: –
Content
Type:
–
Response:
Add.
Headers:
WWW-Authenticate – BASIC (Prompt for Basic
Authorization Credentials when no Authorization header
specified)
Page 320