Skip to content

Latest commit

 

History

History
92 lines (55 loc) · 2 KB

README.md

File metadata and controls

92 lines (55 loc) · 2 KB
Raw

Oxxa API client

PHP client for the Oxxa API.

Support

This client was written by Cyberfusion. It has been open sourced for the community. If you have any questions, open an issue on GitHub or email [email protected].

This client is not supported by Oxxa.

Requirements

This client requires PHP 8.1 or higher with default PHP modules.

Installation

This client can be used in any PHP project and with any framework.

Install the client with Composer:

composer require cyberfusion/oxxa-api-client

Usage

Getting started

// Initialize the API
$oxxa = new Oxxa($username, $password);

// Perform calls to an endpoint
$available = $oxxa
    ->domain()
    ->check('cyberfusion.nl');

Test mode

To test your implementation, use the test mode. All requests tell the Oxxa API that the request is a test.

Enable:

$oxxa->enableTestMode();

Disable:

$oxxa->disableTestMode();

Mock server

When testing with a mock server, you will be able to modify the base URL of the API with:

$oxxa->setBaseUri('http://localhost:8080');

This will return the Oxxa instance, so you can chain it with other methods.

Exceptions

In case of errors, the client throws exceptions using the OxxaException as base class. All exceptions have a specific code. These can be found in the OxxaException class.

Tests

Unit tests are available in the tests directory. Run:

composer test

To generate a code coverage report in the build/report directory, run:

composer test-coverage

Contribution

Some basic endpoints are implemented, but there are a lot which are not implemented yet. Feel free to contribute! See the contributing guidelines.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

License

This client is open-sourced software licensed under the MIT license.