Skip to content

update readme to include information about client implementation #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lordrhodos wants to merge 2 commits into
base: master
Choose a base branch
from
Open

update readme to include information about client implementation #21

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37613be
update readme to include information about client implementation
Aug 26, 2019
4d418d6
adds example how to create the sdk and call operations on the client
Aug 27, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 39 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,51 @@
- PHP >= 7.1 (extension requirements in composer.json).

## Installation
Use [composer](https://getcomposer.org/?target=_blank) to install the package
The sdk uses the [httplug](http://docs.php-http.org/en/latest/httplug/introduction.html) library for the http client implementation,
so you will need to install a library that provides the virtual `php-http/client-implementation` composer package, e.g. `php-http/guzzle6-adapter`.

Use [composer](https://getcomposer.org/?target=_blank) to install a http client of your choice

```bash
$ composer require php-http/guzzle6-adapter
```

and the sdk itself:

```bash
$ composer require starweb/shop-api-sdk
```

# Documentation
The Starweb Shop API SDK uses an auto generated client
The Starweb Shop API SDK uses an auto generated client based on [Jane](https://jane.readthedocs.io/) at its core.
Copy link

@felixsand felixsand Aug 26, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we also should add something here of how to use it:

$credentials = new ClientCredentials('my-client-id', 'my-client-secret');
$starweb = Starweb::create($credentials, 'https://my-shop.starwebserver.se/api/v2');
$client = $starweb->getClient();

$products = $client->listProducts(); // fetch products

Copy link

@felixsand felixsand Aug 26, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would have saved me a LOT of time when I tried to get started 😉

Copy link
Contributor Author

@lordrhodos lordrhodos Aug 27, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added some documentation how to get started


All you need to get started with the sdk is to create an instance of [`ClientCredentials`](src/Api/Authentication/ClientCredentials.php) passing your client id and client secret to the constructor.
Together with your APIs base url you can than use the static factory method to create the sdk:

$credentials = new ClientCredentials('my-client-id', 'my-client-secret');
$starweb = Starweb::create($credentials, 'https://my-shop.starwebserver.se/api/v2');

**Make sure to store your credentials in a secure way**. We recommend using environment variables.

Once you have the sdk created you can get the client and start using it:

// get the client from the sdk
$client = $starweb->getClient();

// fetch products
$products = $client->listProducts();

/**
* @see \Starweb\Api\Generated\Model\ProductModelCollection
* @see \Starweb\Api\Generated\Model\ProductModel
*/
foreach($products->getData() as $product) {
$categories = $product->getCategories();
}

// get a single product
$product = $client->getProduct(123);

# Issues
Please use the [issue tracker](https://github.com/starweb/shop-api-sdk-php/issues?target=_blank) if you find any issues.

Expand Down