README

Datatrics PHP API client

This package is a convenience wrapper to communicate with the Datatrics REST-API

Installation

For the installation of the client, there are 2 ways. The composer way is preferable, but not always possible.

Composer

Include the package in your composer.json file

{
    "require": {
        "datatrics/php-api": "2.0.x-dev"
    }
}

...then run composer update and load the composer autoloader:

<?php
require 'vendor/autoload.php';

// ...

Manual

Obtain the latest version of the Datatrics PHP API client

git clone https://github.com/Datatrics/php-api

And include the class in your project

require_once '/path/to/Client.php';

Usage

There are a lot of API resources that are accessible through this client. You can look them up by looking at the code. Their name matches the name in the documentation(https://docs.datatrics.com).

<?php
require 'vendor/autoload.php';

$client = new Client('[api-key]', '[project-id]');

$project = $client->Project->Get('[project-id]');

Explanation

[api-key] The API key you've received or created

[project-id] id of the project

Contributing

We love contributions, but please note that the API client is generated. If you have suggested changes, you may still create a PR, but your PR will not be merged. We will however adapt the generator to reflect your changes. You can also create a GitHub issue if there's something you miss.

datatrics / php-api

Maintainers

Details