apiThumb

1.0

Sphereon BV

12/Jan/2018 16:12:59 PM CET

PUBLISHED

Production and Sandbox Endpoints

Production and Sandbox URLs:
http://gw.api.cloud.sphereon.com/pdf/1.0
https://gw.api.cloud.sphereon.com/pdf/1.0

Description

The PDF conversion API 'conversion2pdf' converts image, office and PDF files to (searcheable) PDF files. The flow is generally as follows: 1. First upload an image/file using the /conversion2pdf POST endpoint. You will get back a job response that contains a job with its associated settings. 2. Upload any additional images/files using the /conversion2pdf/{jobId} POST endpoint when you want to merge additional image, office or PDF files. You will get back the update job response that contains a job with its associated settings. Currently you can only merge spreadsheets with spreadsheet, documents with documents and images/pdfs with images/pdfs 3. Start the job from a PUT request to the /conversion2pdf/{jobid} endpoint, with the Job and Settings JSON as request body. The conversion to PDF will now start. The OCR setting is only applicable to images, since other files will always be searchable. 4. Check the job status from the /conversion2pdf/{jobid} GET endpoint until the status has changed to DONE or ERROR. Messaging using a websocket will be available as an alternative in a future version 5. Retrieve the PDF file using the /conversion2pdf/{jobid}/stream GET endpoint. This will return the PDF file only when the status is DONE. In other cases it will return the Job Response JSON (with http code 202 instead of 200) Interactive testing: A web based test console is available in the Sphereon API Store

Business Information

Business Owner : Sphereon BV [support@sphereon.com]

Technical Owner : Sphereon Devops Team [dev@sphereon.com]

Share

Comments

No comments yet

Notice

You require an access token to try the API. Please login and subscribe to the API to generate an access token.   If you already have an access token, please provide it below.

Warning! The selected application does not have an access token for the selected environment. Please go to the subscription page and generate an access token first.
Authorization : Bearer
Name Summary
Readme first Readme first View Content
Authentication Authenticate against the REST API View Content
Name Summary
SDK sources and examples SDK sources and examples https://github.com/Sphereon-SDK/pdf-sdk