$ git clone [email protected]:valsplat/simplicate-api-client.git
$ cd simplicate-api-client
$ composer update -o
$ composer require valsplat/simplicate-api-client
This API client is very much a work in progress and is incomplete at this time. You can only use the Project endpoint. Feel free to create a Pull Request to increase coverage.
Authentication is done via providing your account ID and a personal access token:
$connection = new \Valsplat\Simplicate\Connection();
$connection->setApiUrl('https://YOURDOMAIN.simplicate.nl/api/v2');
$connection->setAccessToken('ACCESS_TOKEN');
$connection->setAccountId('ACCOUNT_ID');
The API client throws two exceptions:
\Valsplat\Simplicate\Exceptions\NotFoundException- Entity could not be found\Valsplat\Simplicate\Exceptions\ApiException- Generic Api exception
Each endpoint is accessible via its own method on the \Valsplat\Simplicate\Simplicate instance. The method name is singular, camelcased:
$simplicate = new \Valsplat\Simplicate\Simplicate($connection);
$simplicate->TaskAssignment();
list((array)params)- get a collection of entities. You find the available params per endpoint in the Harvest docs.get((int)id)- get a single entity via its id.create()- create given entity.update()- update given entity.save()- convenience method; callsupdate()if the entity already exists,create()otherwise.delete()- delete given entity.
Authentication and usage examples: example.php
- Tests w/ mocked http client
- Complete endpoint support
- Automatic marshaling of attributes
