Download the PHP package cloudpdf/api without Composer
On this page you can find all versions of the php package cloudpdf/api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package api
CloudPDF PHP
PHP wrapper for the CloudPDF API - an cloud-based PDF management service.
Installation
Install the package with:
composer require cloudpdf/apiTo use the bindings, load it via Autoload
Usage
Table of Contents
- Authentication
- Account Info
- Documents
- Webhooks
Authentication
Get the API key for your project from your CloudPDF Dashboard → Settings → API Keys.
Account Info
Return info about the Account associated with this API key.
Documents
Create a Document
Before you can upload a PDF to CloudPDF you must create a new document.
The server will return a pre-signed Amazon upload URL where you can upload your PDF file using a PUT request.
After uploading the file you must notify our server that the upload is finished and we will process the PDF by our PDF engine.
Options
name: The name of the PDF you want to upload (string)description: Description of the PDF you want to upload (string)parentId: The ID of the folder you want to create the document in (string)tags: Set tags on the document to easily filter and search documents later (array)defaultPermissions: Set the default permissions for this document. You can find all parameters in te API docs. If none are given we use the default permissions of the organization. You can change the default permissions of the organization in the Dashboard → Settings → Upload Settings. (object)
Get a Document
Update a Document
Options
name: The name of the PDF you want to upload (string)description: Description of the PDF you want to upload (string)parentId: The ID of the folder you want to create the document in (string)tags: Set tags on the document to easily filter and search documents later (array)defaultPermissions: Set the default permissions for this document. You can find all parameters in te API docs. If none are given we use the default permissions of the organization. You can change the default permissions of the organization in the Dashboard → Settings → Upload Settings. (object)
Delete a Document
Upload file
After you create a document you will receive an Amazon signed URL where you can upload your PDF file using a PUT request. We suggest to upload the file directly from the clients browser to spare your server load. Below you find an example using axios in typescript.
When the file upload is finished you must notify our server.
Upload file completed
After uploading your file to Amazon S3 you must notify our server on this endpoint that the upload is complete. On a successful request the status of the document will change from "WaitingUpload" to "Processing".
You can poll the use a webhook to find out if your document has completed processing by our PDF engine.
Get a file
Webhooks
Webhooks are used to notify your system of specific CloudPDF events.
Create a Webhook
Options
name: The name of your webhook for your own reference (string)url: The URL that the webhook should trigger on a event (string)secret: Optional secret that you can use to secure the webhook endpoint (string)events: An array of events. Possible values are: document.created, document.updated, collection.created, collection.updated, tracker.new, lead.new, file.processed (array)headers: Object of header keys and values that will be sent as request header on the webhook request (object)
Get a Webhook
Update a Webhook
Options
name: The name of your webhook for your own reference (string)url: The URL that the webhook should trigger on a event (string)secret: Optional secret that you can use to secure the webhook endpoint (string)events: An array of events. Possible values are: document.created, document.updated, collection.created, collection.updated, tracker.new, lead.new, file.processed (array)headers: Object of header keys and values that will be sent as request header on the webhook request (object)
Delete a Webhook
List all Webhooks
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/cloudpdf-io/cloudpdf-php.
License
The repository is available as open source under the terms of the MIT License.
