Download the PHP package icontact/booxtreamclient without Composer
On this page you can find all versions of the php package icontact/booxtreamclient. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download icontact/booxtreamclient
More information about icontact/booxtreamclient
Files in icontact/booxtreamclient
Package booxtreamclient
Short Description A simple example client for the BooXtream webservice
License MIT
Homepage https://github.com/BooXtream/php-BooXtreamClient/
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 booxtreamclient
BooXtreamClient
A client class in PHP for use with the BooXtream webservice.
- Has the ability to upload an epub file to the BooXtream webservice
- Alternatively specify an epub file stored on the BooXtream storage servers
- Can return an epub file, a (converted) mobi file or an xml containing one or more downloadlinks
Installing via Composer
BooXtreamClient is available in Packagist, just add it to your composer.json
or
Alternatively you can just download the package and run to get the requirements.
The only requirements at the moment are PHP 7.2.5 and up and Guzzle.
If you do not wish to use Composer you will need to fulfill the dependencies on your own.
Usage
You will need:
- a username and API key for the service
- an array of options (refer to the BooXtream web service API documentation)
- an epub file or a file stored on the BooXtream service
The type parameter can be either 'epub', 'mobi' or 'xml'. In the first two cases a file will be returned by the service, in the case of 'xml' you will receive one or two downloadlinks, depending on your settings (aka delivery platform).
We're now going to send the request.
A request with a stored file is slightly different. Instead of adding an epubfile you just need to provide the name of the file (with or without .epub extension):
Options
The available options are as follows. Refer to the API Documentation for details:
required:
- customername (string)
- customeremailaddress (string)
- referenceid (string)
- languagecode (int)
additionaly required if using xml (aka delivery platform):
- expirydays (int)
- downloadlimit (int)
optional:
- exlibrisfont (string), this should contain either 'sans', 'serif' or 'script'
- exlibris (bool), default: false
- chapterfooter (bool), default: false
- disclaimer (bool), default: false
- showdate (bool), default: false
optional if using xml (aka delivery platform):
- epub (bool), default: true
- kf8mobi (bool), default: false
custom ex libris
It is also possible to set a custom ex libris file according to the specifications in the API Documentation.
Response
The BooXtreamClient returns an object of the type of GuzzleHttp\Psr7\Response
The response always contains a statuscode (). If the request was successful this will be 200. Any other status code is an error and will throw an Exception of the type of GuzzleHttp\Exception\ClientException. You can retrieve a Response object as follows:
Check the HTTP Reason () for more information.
Epub/Mobi
If you requested an epub or mobi file this can be accessed by reading the body (). The body is a stream, refer to the PHP Documentation for more information on how to access it. Furthermore you can access the file's content-type with .
XML or error
If you requested xml (aka delivery platform) or if an error occurred more information can be found by accessing the body (). The body is a stream, refer to the PHP Documentation for more information on how to access it.
The XML looks like this:
- Request, containing information about the request you made (options, etc)
- Response, containing either a set of downloadlinks or more information on an error
