README

The official PHP library for the Utrust API.

Minimum Requirements

PHP version 5.4 or above.

Install

Install with composer:

composer require utrust/utrust

Usage

API Client

Creating a new Order:

use AbumUtrust\ApiClient;

$utrustApi = new ApiClient('API_KEY');

$orderData = [...];
$customerData = [...];

$response = $utrustApi->createOrder($orderData, $customerData);
echo $response->attributes->redirect_url;

Check the full example here.

Validations

The Validator class can be used to check your data array before passing it to the API Client. It will throw an exception with the errors array if the validations don't pass, otherwise it will return true:

$orderIsValid = Validator::order($orderData);
$customerIsValid = Validator::customer($customerData);

if ($orderIsValid && $customerIsValid) {
    // create the order here
}

Webhooks

The Webhook\Event class can be used to verify an incoming event via Webhook. It will throw an exception if the event has an invalid format or invalid signature:

$event = new Event($payload);
$event->validateSignature($webhooksSecret);

Check the examples/ directory for further details.

Contribute

This library was written and is maintained by the Utrust development team. We have now opened it to the world so that the community using this library may have the chance of shaping its development.

You can contribute by simply letting us know your suggestions or any problems that you find by opening an issue on GitHub.

You can also fork the repository on GitHub and open a pull request for the master branch with your missing features and/or bug fixes. Please make sure the new code follows the same style and conventions as already written code. Our team is eager to welcome new contributors into the mix 😊.

Tests

When contributing with new changes, please make an effort to provide the respective tests. This is especially important when fixing any problems, as it will prevent other contributors from accidentally reintroducing the issue in the future.

Before submitting a pull request with your changes, please make sure every test passes:

composer test

When in doubt whether you caused a test to fail, check the build for master in CircleCI.

Lint

This project uses PHPCodeSniffer with PSR-2 coding stardard.

Before contributing your changes, make sure it passes on the linter:

composer lint

When in doubt whether you introduced a linter error, check the build for master in CircleCI.

Publish

We are publishing the library to Packagist. We are using semantic versioning to keep track of package changes. To publish a new package version run the following commands:

git tag v1.0.0
git push origin v1.0.0

License

Utrust PHP is maintained with 💜 by the Utrust development team, and is available to the public under the GNU GPLv3 license. Please see LICENSE for further details.

abumutrust / utrust

Maintainers

Details