someline/rest-api-client

An elegant and smart Rest API Client with OAuth2 authentication support. Build for Laravel and Someline Starter.

Someline Rest API Client

, _(*1)

Someline Starter API Client is an elegant and smart Rest API Client with OAuth2 authentication support., _(*2)

Build for Laravel and Someline Starter., _(*3)

It can be used for accessing APIs created using Someline Starter framework., _(*4)

Install

Via Composer

Install composer package to your laravel project, _(*5)

``` bash composer require someline/rest-api-client, <sub>(*6)</sub>

Add Service Provider to `config/app.php`

``` php
    'providers' => [
        ...
        Someline\Rest\RestClientServiceProvider::class,
        ...
    ],

Publishing config file., <sub>(*7)</sub>

``` bash php artisan vendor:publish, <sub>(*8)</sub>

After published, config file for Rest Client is `config/rest-client.php`, you will need to config it to use Rest Client.

## Usage

``` php
$restClient = new \Someline\Rest\RestClient('someline-starter');

$restClient->setOAuthUserCredentials([
    'username' => 'libern@someline.com',
    'password' => 'Abc12345',
]);
$restClient->withOAuthTokenTypeUser();

$response = $restClient->get("users")->getResponse();
if (!$restClient->isResponseStatusCode(200)) {
    $restClient->printResponseOriginContent();
    $responseMessage = $restClient->getResponseMessage();
    print_r($responseMessage);
} else {
    $responseData = $restClient->getResponseData();
    print_r($responseData);
}

Testing

bash phpunit, <sub>(*9)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*10)</sub>

Credits

• Someline
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*11)</sub>