An open API service indexing awesome lists of open source software.

https://github.com/steeinru/steein-sdk-php

Steein SDK for PHP - client library.
https://github.com/steeinru/steein-sdk-php

php php7 rest-api sdk steein steein-php-sdk

Last synced: about 1 month ago
JSON representation

Steein SDK for PHP - client library.

Awesome Lists containing this project

README

          

# Steein SDK for PHP

***Welcome to Steein PHP SDK.*** This repository contains Steein's PHP SDK and samples for REST API.

## Installation

The preferred method is via composer. Follow the installation instructions if you do not already have composer installed.
Once composer is installed, execute the following command in your project root to install this library:

```
composer require steein/steein-sdk
```
Finally, be sure to include the autoloader:

```php
require_once '/path/to/your-project/vendor/autoload.php';
```

## SDK Documentation

* [Documentation](https://www.steein.ru/developers/docs/steein-api.overview)
* [API Reference](https://www.steein.ru/developers/docs/api-reference.common-objects)
* [Samples](https://github.com/SteeinRu/steein-api-samples)
* [Installation](https://www.steein.ru/developers/docs/sdk-quickstart-guide.install)
* [Make your First SDK Call](https://www.steein.ru/developers/docs/steein-api.make-your-first-call)

## Usage

Simple GET example of a user's account.

### Version 1

***sdk-config.ini***

```ini
[Account]
acct1.ClientId = {id}
acct1.ClientSecret = {secret_key}
acct1.VersionApi = v2.0
```

***index.php***
```php
define('STEEIN_CONFIG_PATH', __DIR__);
$steein = new Steein();
```

### Version 2

```php
$steein = new Steein([
'client_id' => '{id}',
'client_secret' => '{secret_key}',
'default_api_version' => 'v2.0'
]);
$steein->setDefaultAccessToken('{access_token}');

$get = $steein->get('/users/show'); //$steein->get('/users/show',['id' => 1]);
$user = $get->getUserModel(); //$get->getDecodedBody()

echo 'ID: '. $user->getId(); //or $user->all();
```

Complete documentation, installation instructions, and examples are available [here](https://www.steein.ru/developers/docs/php/getting_started).

### License

Please see the [license file](https://github.com/SteeinRu/steein-sdk-php/blob/master/LICENSE) for more information.