wickedreports/php-sdk

PHP SDK for WickedReports

Wicked Reports PHP SDK (beta)

Documentation

You can find current API documentation in this doc., _(*1)

Install

Using the composer CLI:, _(*2)

composer require wickedreports/php-sdk

Or manually add it to your composer.json:, _(*3)

``` json { "require": { "wickedreports/php-sdk": "1.5.*" } }, <sub>(*4)</sub>

## Authentication
To use API SDK, you should have your own API key.

```php
$api = new \WickedReports\WickedReports($yourApiKey);
$api->addOrders($orders);

Examples

You can see list of usage examples in examples/example.php file., <sub>(*5)</sub>

Dates

DateTime objects are used instead of a DateTime string where the date(time) is a parameter in the method., <sub>(*6)</sub>

$datetime = new \DateTime('now', new \DateTimeZone('America/New_York'));

As other way, you can use simple date-time string with timezone property set., <sub>(*7)</sub>

[
    'CreateDate' => '2017-08-01 00:05:01',
    'timezone'   => 'EST'
]

You can see list of supported timezones on PHP.net website., <sub>(*8)</sub>

You have to use one of these ways to provide date time, otherwise you will get error or wrong date saved into our DB., <sub>(*9)</sub>

Provided date-time string will be automatically converted to UTC timezone, as it requires our API documentation., <sub>(*10)</sub>

Testing

bash $ phpunit, <sub>(*11)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*12)</sub>