Printcalc Logo

API Documentation - Version: 1.1.0

Test / Demo client (C#/.net) available here: https://bitbucket.org/brightertools/printcalcapiclient

For additional help and support, please contact: support@brightertools.com

API CALLS

Gets a session key for the specified Api key credentials (ApiKey, Username and Password).
API Key available on the API Access tab on your Account Page
There is currently no expiry on the session key, so this can be retrieved once and stored within the configuration of your own system.
Session key (SessionKey) and username (Username) headers are required for all subsequent calls to the API.

Endpoint: www.printcalc.com/api/v1/GetSessionKey

Http Method: POST

Request Information

Body Parameters
Name Description Type Additional Information
ApiKey PrintCalc account API Key (Get the API key on the My Account page) String Required
Username PrintCalc account username (email address) String Required
Password PrintCalc account password String Required

Response Information

The session key for validated api key and user credentials, otherwise returns an empty string.

Returns true if the supplied headers (SessionKey) and (Username) are valid.

Endpoint: www.printcalc.com/api/v1/IsSessionKeyValid

Http Method: POST

Response Information

Returns true if the session key for the supplied headers (SessionKey and Username) and has not expired, else returns false.

Uploads a File for Processing

The UploadFile call expects the following posted multipart/form-data

POST Information

Name Description Type Additional Information
Description The description or name of the file String Required
PreProcessingOption Pre Processing Options: 0 = None, 1 = Convert to CMYK, 2 = Convert to Grayscale Integer Optional
File A file for processing including file types: .pdf .ps .eps Required

Endpoint: www.printcalc.com/api/v1/UploadFile

Http Method: POST

Response Information


Name Description Type Additional Information
Id The Id of the File Uploaded Integer

Gets the PrintCalc file results for the specified File Id

Endpoint: www.printcalc.com/api/v1/GetFileResults?Id={Id}

Http Method: POST

Request Information

URI Parameters
Name Description Type Additional Information
Id The File Id Integer Required

Response Information

PrintCalc Results:

Name Description Type Additional Information
Status File Processing Status String Including: Processing, Processed, ProcessingFailed, CheckAccountCreditStatus
Filename Original Filename String
Description Description String
UploadedDate UploadedDate String In the format: dd/MM/yyy hh:mm:ss
PageCount Number of Pages in File Integer
Separations List of Color Separations in File Array of String
FileResults The PrintCalc Total File Results (the same as the File Results Tab within PrintCalc) CoverageResults (see below)
PageResults The PrintCalc Results per Page (Results for each page, same as the Page Results Tab within PrintCalc) List of CoverageResults Type (see below)

CoverageResults
Name Description Type Additional Information
Page The Page Number for PageResults (or zero for File Results) Integer None
TotalCoverage The Page Coverage for PageResults, or the Total File Coverage for FileResults float None
Values A List of the Separation Coverage Values, containing the Color and Percentage List of CoverageResult Type (se below)

CoverageResult
Name Description Type Additional Information
Separation The Color Separation Name (eg: Cyan, Magenta, Yellow, Black or spot colour name) String None
Coverage The separation coverage as a percentage float None

Gets the API Version.

Endpoint: www.printcalc.com/api/v1/GetApiVersion

Http Method: GET

Response Information

String in the format 1.x.x (Major.Minor.Revision)

Version History / Release Notes:

VERSION: 1.1.0
ADDED: File Pre Processing Option

VERSION: 1.0.0
Initial Release

© 2017 Brighter Tools Ltd