Skip to content

sandwave-io/basekit-php

Repository files navigation

BaseKit RESTful API - PHP SDK

Codecov GitHub Workflow Status Packagist PHP Version Support Packagist PHP Version Support Packagist Downloads

Supported APIs

This SDK currently supports these APIs:

Are you missing functionality? Feel free to create an issue, or hit us up with a pull request.

How to use (REST API)

use SandwaveIo\BaseKit\BaseKit;

$basekit = new BaseKit('<user>', '<password>', '<api-url>');

$accountHolderRef = 123;
$brandRef = 456;

$basekit->sitesApi->create($accountHolderRef, $brandRef, "example.com");

How to contribute

Feel free to create a PR if you have any ideas for improvements. Or create an issue.

  • When adding code, make sure to add tests for it (phpunit).
  • Make sure the code adheres to our coding standards (use php-cs-fixer to check/fix).
  • Also make sure PHPStan does not find any bugs.
vendor/bin/php-cs-fixer fix

vendor/bin/phpstan analyze

vendor/bin/phpunit --coverage-text

These tools will also run in GitHub actions on PR's and pushes on master.