sandwave-io/basekit-php

A PHP SDK for the BaseKit REST API.

2024.09.26.3 2024-09-26 12:29 UTC

Requires

• php: ^8.1
• ext-json: *
• guzzlehttp/guzzle: ^7.5.0
• psr/log: ^1.0|^2.0|^3.0
• webmozart/assert: ^1.11.0

Requires (Dev)

• ekino/phpstan-banned-code: ^1.0.0
• ergebnis/phpstan-rules: ^1.0.0
• friendsofphp/php-cs-fixer: ^3.14.4
• phpstan/phpstan: ^1.10.6
• phpstan/phpstan-deprecation-rules: ^1.1.2
• phpstan/phpstan-strict-rules: ^1.5.0
• phpunit/phpunit: ^10.0.15
• sandwave-io/php-cs-fixer-config: ^1.0
• thecodingmachine/phpstan-strict-rules: ^1.0.0

MIT

• Thomas Ploegaert

README

BaseKit RESTful API - PHP SDK

Supported APIs

This SDK currently supports these APIs:

• Package API
• Sites API
• Ssl API
• Users API

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.