Skip to content

Latest commit

 

History

History
89 lines (51 loc) · 4.96 KB

README.md

File metadata and controls

89 lines (51 loc) · 4.96 KB
Raw

Logo

ReportingCloud PHP SDK

Build Status Scrutinizer Code Quality Latest Stable Version composer.lock available

This is the official PHP SDK for the ReportingCloud Web API. It is authored and supported by Text Control GmbH.

Learn more about ReportingCloud at:

Learn more about ReportingCloud PHP SDK at:

Minimum Requirements

As of ReportingCloud PHP SDK 4.0, the PHP SDK requires PHP 8.1 or PHP 8.2.

All versions of PHP prior to 8.1 have reached end-of-life and will no longer receive security updates. If your application is running in an older environment, it is highly recommended that you upgrade to a more recent version of PHP.

If you are unable or unwilling to upgrade your PHP installation, you may consider using ReportingCloud PHP SDK 3.0, which supports PHP 8.0, ReportingCloud PHP SDK 2.0, which supports PHP 7.1, or ReportingCloud PHP SDK 1.0, which supports PHP 5.6.

Please note that these versions are no longer maintained.

Alternatively, it is possible to use ReportingCloud by directly accessing the Web API. In this case, it is recommended to use the curl extension to make the API calls.

Install Using Composer

Install ReportingCloud PHP SDK 4.0 in your project using Composer:

composer require textcontrol/textcontrol-reportingcloud:^4.0

After installing, you just need to include Composer's autoloader:

include_once 'vendor/autoload.php';

You are now ready to use the SDK.

API Key for Demos and Unit Tests

ReportingCloud PHP SDK ships with a number of sample applications (see /demo directory) and phpunit tests (see /test directory). The scripts in each of these directories require an API key for ReportingCloud to run. To avoid accidentally exposing the API key via a public GIT repository, you need to specify it first. There are two ways to do this:

Using PHP Constants:

define('REPORTING_CLOUD_API_KEY', 'your-api-key');

Using Environmental Variables (For Example in .bashrc)

export REPORTING_CLOUD_API_KEY='your-api-key'

Note that these instructions only apply to the demo scripts and phpunit tests. If you are using ReportingCloud in your application, set the API key in your constructor or by using the setApiKey($apiKey) methods. See /demo/instantiation.php for an example.

Getting Started

The PHP Quickstart Tutorial in the ReportingCloud Documentation is your starting point for using the ReportingCloud PHP SDK in your own applications.

In addition, ReportingCloud PHP SDK ships with a number of sample applications (see /demo directory). These well commented sample applications have been written to demonstrate all parts of ReportingCloud.

Getting Support

The ReportingCloud PHP SDK is written and supported by Text Control GmbH, the manufacturer of the ReportingCloud Web API.

Despite our best efforts to create understandable documentation, demo applications, and unit tests, we understand that there are times when you may need technical assistance.

If you have a question about ReportingCloud or the PHP SDK, we want to help.

Please refer to the Getting Support section of the ReportingCloud Documentation to learn more about the support channels available to you.