Download the PHP package onoffice/sdk without Composer
On this page you can find all versions of the php package onoffice/sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package sdk
Short Description Official client to communicate with the onOffice API
License MIT
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 sdk
onOffice-SDK
This project is the official PHP API client for the onOffice API supported by the onOffice GmbH.
- The HTTP protocol is used to communicate with the API.
- An Access Token and TLS connection are used to ensure a secure communication with the API.
- The intention is to have lightweight client that can be used in other environments
Table of Contents
- Quickstart Example
- Usage
- Client
- Parameters
- Request
- Response
- API Documentation
- Install
- Contributing
- License
Quickstart Example
Checkout the examples folder to see a possible implementation of this client.
Usage
Client
The onOfficeSDK is responsible for creating HTTP Requests and
receiving HTTP Responses from the official API
Make sure that the correct API version is used for your client.
By default this value is set to stable.
Parameters
The parameters are transferred as JSON in the HTTP Request. The client uses the official PHP array notation before transforming the array to JSON.
Request
To create a request to the API an ACTION_ID is needed.
The class onOfficeSDK defines several constants,
that can be used, so there is no need to copy these ACTION_IDs.
A token and secret are needed to send a request to the API. Check out the official API documentation for information on how to acquire these credentials.
The return value of onOfficeSDK::callGeneric is used to identify the
equivalent response value.
onOfficeSDK::callGeneric can be called multiple times before sending
the request to the API via onOfficeSDK::sendRequests.
Response
Use the method onOfficeSDK::getResponseArray to fetch the response data for a request.
To identify the response of the request, use the value returned by onOfficeSDK::callGeneric.
The response will be a PHP array.
Difference between call and callGeneric
This library will provide two general methods to create the calls to the onOffice API.
callGenericis used to create simple calls e.g. Estate searches or reading addressescallcan be used more specific for special API Requests. Some API Request need some more information likeidentifier,resourceIdandresourceTypeto be processed. These can be calls like Estate files or Editing Addresses
Check the API documentation for more information.
API Documentation
The API client is developed for the latest version of the official API. Additional information about the API can be found here.
Install
The recommended way to install this library is through Composer. New to Composer?
This will install the latest supported version:
See also the CHANGELOG for details about version upgrades.
Contributing
You want to contribute? Great!
Check out our contribution rules and get started!
License
This project is licensed under the MIT License. See LICENSE document.
All versions of sdk with dependencies
ext-curl Version *