Download the PHP package fw4/whise-api without Composer

On this page you can find all versions of the php package fw4/whise-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Informations about the package whise-api

Whise API

PHP client for the Whise API. For terms of use and API credentials, refer to the official documentation.

Installation

composer require fw4/whise-api

Usage

All endpoints are provided as methods of the WhiseApi class. For more information about available endpoints and response format, refer to the official API documentation.

Available endpoints

Use the following methods to access available endpoints:

Administration

Estates

Contacts

Calendars

Activity

Pagination

Endpoints that retrieve multiple items return a traversable list of objects. Pagination for large lists happens automatically.

Manual pagination

For situations where manual pagination is required, a page method is provided. Calling this method with both a desired page index (starting at 0), and the amount of items to retrieve per page, returns a traversable list of objects. This list also provides multiple methods for dealing with paging metadata:

Example

Caching

It's possible to enable caching by using a PSR-6 compatible cache adapter. Do note that this will cause all read operations to be cached, overriding any cache-control policy used by the Whise API, violating RFC.

You can change the default cache lifetime of one hour, as well as the cache key prefix, by using the second and third parameters of setCache respectively. These can also be changed at runtime by using the setCacheTtl and setCachePrefix methods.

Responses are cached per access token, so make sure to reuse your access token to share a cache across script executions.

To determine whether a response was returned from cache, call the isCacheHit method. This method is not available when using automatic pagination.

License

fw4/whise-api is licensed under the MIT License (MIT). Please see LICENSE for more information.


All versions of whise-api with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4|^8.0|^8.1
guzzlehttp/guzzle Version ~6.0|~7.0
ocramius/package-versions Version ^2.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package fw4/whise-api contains the following files

Loading the files please wait ....