bitinflow Accounts

PHP bitinflow Accounts API Client for Laravel 5+

Table of contents

1. Installation
2. Configuration
3. Examples
4. Documentation
5. Development

Installation

composer require ghostzero/bitinflow-accounts

If you use Laravel 5.5+ you are already done, otherwise continue.

Add Service Provider to your app.php configuration file:

GhostZero\BitinflowAccounts\Providers\BitinflowAccountsServiceProvider::class,

Configuration

Copy configuration to config folder:

$ php artisan vendor:publish --provider="GhostZero\BitinflowAccounts\Providers\BitinflowAccountsServiceProvider"

Add environmental variables to your .env

BITINFLOW_ACCOUNTS_KEY=
BITINFLOW_ACCOUNTS_SECRET=
BITINFLOW_ACCOUNTS_REDIRECT_URI=http://localhost

Examples

Basic

$bitinflowAccounts = new GhostZero\BitinflowAccounts\BitinflowAccounts();

$bitinflowAccounts->setClientId('abc123');

// Get SSH Key by User ID
$result = $bitinflowAccounts->getSshKeysByUserId(38);

// Check, if the query was successfull
if ( ! $result->success()) {
    die('Ooops: ' . $result->error());
}

// Shift result to get single key data
$sshKey = $result->shift();

echo $sshKey->name;

Setters

$bitinflowAccounts = new GhostZero\BitinflowAccounts\BitinflowAccounts();

$bitinflowAccounts->setClientId('abc123');
$bitinflowAccounts->setClientSecret('abc456');
$bitinflowAccounts->setToken('abcdef123456');

$bitinflowAccounts = $bitinflowAccounts->withClientId('abc123');
$bitinflowAccounts = $bitinflowAccounts->withClientSecret('abc123');
$bitinflowAccounts = $bitinflowAccounts->withToken('abcdef123456');

OAuth Tokens

$bitinflowAccounts = new GhostZero\BitinflowAccounts\BitinflowAccounts();

$bitinflowAccounts->setClientId('abc123');
$bitinflowAccounts->setToken('abcdef123456');

$result = $bitinflowAccounts->getAuthedUser();

$user = $userResult->shift();

$bitinflowAccounts->setToken('uvwxyz456789');

$result = $bitinflowAccounts->getAuthedUser();

$result = $bitinflowAccounts->withToken('uvwxyz456789')->getAuthedUser();

Facade

use GhostZero\BitinflowAccounts\Facades\BitinflowAccounts;

BitinflowAccounts::withClientId('abc123')->withToken('abcdef123456')->getAuthedUser();

Documentation

Users

public function getAuthedUser()

SshKeys

public function getSshKeysByUserId(int $id)
public function createSshKey(string $publicKey, string $name = NULL)
public function deleteSshKey(int $id)

OAuth Scopes Enums

Development

Run Tests

composer test

CLIENT_ID=xxxx CLIENT_KEY=yyyy CLIENT_ACCESS_TOKEN=zzzz composer test

Generate Documentation

composer docs

---

Join the bitinflow Discord!