Download the PHP package carboneio/carbone-sdk-php without Composer
On this page you can find all versions of the php package carboneio/carbone-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download carboneio/carbone-sdk-php
More information about carboneio/carbone-sdk-php
Files in carboneio/carbone-sdk-php
Package carbone-sdk-php
Short Description Official Carboneio PHP SDK to generate documents through the Carbone CLOUD API.
License MIT
Homepage https://github.com/carboneio/carbone-sdk-php
Informations about the package carbone-sdk-php
Carbone PHP SDK
This package provides a PHP SDK for the Carbone.io Cloud API.
About Carbone
Carbone is a powerful and easy to use API to generate documents from a template to a PDF. It is based on LibreOffice and can convert any document supported by LibreOffice. It is also possible to convert HTML to PDF. Learn more about supported files and features.
Installation
You can install the bindings via Composer. Run the following command:
Usage
Carbone instance
Using the SDK is very easy. You just need to create a new instance of the Carbone class and provide your API key. Get your API key on your Carbone account: https://account.carbone.io/.
Upload a template
You can upload a template to Carbone using the upload
method. This method takes the content of the template as base64. The method returns a template ID
used to generate documents.
Example to upload a template
Render a template
You can generate a document using the render
method. This method takes the template Id
and the data as parameters. A render ID
is returned and must be used to download the generated document.
Example to render a template
Download a rendered template
You can download a rendered template using the download
method. This method takes the render ID
as a parameter.
Example to download a rendered document
Delete a template
You can delete a template using the delete
method. This method takes the template Id
as a parameter.
Example to delete a template
Download a template
You can download a template using the download
method. This method takes the template Id
as a parameter.
Example to download a template
Add custom headers
Set custom headers, such as "carbone-version" to select a specific Carbone version. By default, the SDK request the version 4 of Carbone.
Get API Status
🧪 Run tests
First install required composer packages:
Then execute tests:
👤 History
The package was originaly made by MadeByBob and open-sourced the code. The Carbone.io team is now maintaining the SDK and will bring all futur evolutions.
Original repository:https://github.com/madebybob/carbone-sdk
MadeByBob website: https://madebybob.nl/
🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check issues page.
Show your support
Give a ⭐️ if this project helped you!