OpenXE/vendor/y0lk/oauth1-etsy/README.md

38 lines
1.5 KiB
Markdown
Raw Normal View History

2021-05-21 08:49:41 +02:00
# Etsy Provider for OAuth 1.0 Client
[![Latest Stable Version](https://img.shields.io/packagist/v/y0lk/oauth1-etsy.svg)](https://packagist.org/packages/y0lk/oauth1-etsy)
[![Build Status](https://img.shields.io/travis/Y0lk/oauth1-etsy.svg)](https://travis-ci.org/Y0lk/oauth1-etsy)
[![License](https://img.shields.io/packagist/l/y0lk/oauth1-etsy.svg)](https://github.com/y0lk/oauth1-etsy/blob/master/LICENSE)
[![Total Downloads](https://img.shields.io/packagist/dt/y0lk/oauth1-etsy.svg?maxAge=2592000)](https://packagist.org/packages/y0lk/oauth1-etsy)
This package provides Etsy API OAuth 1.0 support for the PHP League's [OAuth 1.0 Client](https://github.com/thephpleague/oauth1-client).
## Installation
Via Composer
```shell
$ composer require y0lk/oauth1-etsy
```
## Usage
Usage is the same as The League's OAuth client, using `Y0lk\OAuth1\Client\Server\Etsy` as the provider.
```php
$server = new Y0lk\OAuth1\Client\Server\Etsy([
'identifier' => 'your-client-id',
'secret' => 'your-client-secret',
'scope' => '', //See Etsy documentation for the full list of permission scopes
'callback_uri' => 'http://callback.url/callback'
]);
```
### Permission Scopes
See the Etsy documentation for [Permission Scopes](https://www.etsy.com/developers/documentation/getting_started/oauth#section_permission_scopes)
## License
The MIT License (MIT). Please see [License File](https://github.com/thephpleague/oauth1-client/blob/master/LICENSE) for more information.