Download the PHP package gamez/mite without Composer
On this page you can find all versions of the php package gamez/mite. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package mite
Short Description Interact with mite (https://mite.de) from your PHP application.
License MIT
Homepage https://github.com/jeromegamez/mite-php
Informations about the package mite
mite SDK for PHP
Interact with mite from your PHP application.
- Requirements
- Installation
- Usage
- Basic API client
- Simple API
- Simple Tracker
- Catching errors
- Caching HTTP requests
- Creating your own API client
- License
Requirements
- An account name (The first part of your mite account's domain, e.g. in https://**xxx**.mite.de)
- An API key (You can find your API key on https://xxx.mite.de/myself)
Please note that the capabilities of the library are limited by the permissions of the used credentials. As an example, a user with the role "Time Tracker" can only access data that has been made available to them and is not allowed to create new customers.
Users with the admin
role can see and do (almost) everything.
Installation
In order to use this library, you need a PSR-18 HTTP Client, and a PSR-17 HTTP Message Factory. If you don't already have them available in your project, they will be added to your project's dependencies
Usage
Basic API client
Once you have created an HTTP Client and Request Factory as described in the installation section, you can create an API client with them:
This API client allows you to make authenticated HTTP requests to the API of your mite account - see mite's REST API documentation for the endpoints you can use.
Simple API
Gamez\Mite\SimpleApi
is the easiest and fastest way to access the data in your
mite account. Its methods are named after the available REST API endpoints
and always return arrays of data. You can inspect the available methods by looking at the
source code of the Gamez\Mite\SimpleApi
class or by using the
autocompletion features of your IDE.
The Simple API doesn't get in your way when accessing the mite API, but it doesn't provide additional features either. It will, for example, not tell you if you used a wrong query parameter or invalid field value, so you will have to rely on the returned API responses.
For information on which query parameters and field values are allowed, see official mite API documentation
Example
Simple Tracker
Gamez\Mite\SimpleTracker
allows you to work with mite's time tracker.
Note: You can only access the tracker of the currently authenticated user (identified by the used API key). It is not possible to modify trackers of other users.
Each action on the tracker returns an array with information about the tracked time entry, but you don't have to inspect the result to know if the action has been successful or not - if an action does not throw an error, it has been successful.
Catching errors
All exceptions thrown by this library implement the \Gamez\Mite\Exception\MiteException
interface.
Exceptions thrown while using an API Client will throw a \Gamez\Mite\Exception\ApiClientError
.
Caching HTTP requests
To cache HTTP requests to the API, you can add a caching middleware/plugin to the HTTP client before injecting it into the API client instance. See the documentation of the respective component for instructions on how to do that.
- Guzzle: kevinrob/guzzle-cache-middleware
- HTTPlug: Cache Plugin
Creating your own API client
If you want to create your own API client, implement the \Gamez\Mite\Api\ApiClient
interface
and use your implementation.
License
gamez/mite
is licensed under the MIT License.
Your use of mite is governed by the Terms of Service for mite..
All versions of mite with dependencies
ext-json Version *
ext-mbstring Version *
beste/json Version ^1.2
psr/http-client Version ^1.0.1
psr/http-client-implementation Version ^1.0
psr/http-factory Version ^1.0.1
psr/http-factory-implementation Version ^1.0