Download the PHP package jahudka/fakturoid-sdk without Composer
On this page you can find all versions of the php package jahudka/fakturoid-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package fakturoid-sdk
Fakturoid API v2 SDK
Provides a simplified access to the Fakturoid API.
Installation
Composer
1) Add the SDK repository and package to your composer.json
:
2) Run composer update
in your project directory
Without Composer
1) Download the latest SDK PHAR archive here: https://github.com/jahudka/fakturoid-sdk/releases
2) Unpack the archive wherever you wish and load like this:
Usage
Create a client:
The SDK covers all the currently available API endpoints as specified
in the API docs (http://docs.fakturoid.apiary.io/). The endpoints are available
through properties on the Client
instance, for example the Invoices
endpoint is available as $api->invoices
. The properties are named
the same as the API endpoints they access.
Data from the API is always returned wrapped in an appropriate entity object. The entity objects have the same properties as their respective endpoints, except that property names are camelCase instead of pascal_case.
Caching
Fakturoid recommends that API clients leverage common HTTP caching mechanisms in order to speed up client apps and save bandwidth. This is very easy to do with the FakturoidSDK because you can simply install any caching middleware of your choice in the SDK's instance of GuzzleHttp\Client. See for example https://github.com/Kevinrob/guzzle-cache-middleware.
Traversing the API
Reading list endpoints is easy using the SDK: the endpoint property
itself is an iterator aggregate, meaning that in the simplest case when
you want to read all the entries of a given endpoint you can just directly
use the endpoint in a foreach
loop, for example:
The endpoint iterator of course supports all the filtering and searching options that the API supports, as well as SQL-style limiting, for example:
Getting, creating, updating and deleting entries
All versions of fakturoid-sdk with dependencies
ext-json Version *
ext-fileinfo Version *
guzzlehttp/guzzle Version ^7.4