https://github.com/startz/oauth2-etsy

StartZ oauth2-etsy compatible League of PHP OAuth2
https://github.com/startz/oauth2-etsy

authorization etsy oauth2 oauth2-client openapi package php8

Last synced: 10 months ago
JSON representation

StartZ oauth2-etsy compatible League of PHP OAuth2

• Host: GitHub
• URL: https://github.com/startz/oauth2-etsy
• Owner: startz
• License: mit
• Created: 2022-09-14T19:11:49.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2025-01-13T22:13:22.000Z (about 1 year ago)
• Last Synced: 2025-03-24T22:32:08.459Z (11 months ago)
• Topics: authorization, etsy, oauth2, oauth2-client, openapi, package, php8
• Language: PHP
• Homepage:
• Size: 25.4 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# Etsy Provider for OAuth 2.0 Client

[![GitHub tag](https://img.shields.io/github/tag/startz/oauth2-etsy.svg)](https://github.com/startz/oauth2-etsy/blob/master/tags)

[![GitHub license](https://img.shields.io/github/license/startz/oauth2-etsy.svg)](https://github.com/startz/oauth2-etsy/blob/main/LICENSE)

[![build](https://github.com/startz/oauth2-etsy/actions/workflows/php.yml/badge.svg?branch=master)](https://github.com/startz/oauth2-etsy/actions/workflows/php.yml)

[![codecov](https://codecov.io/gh/startz/oauth2-etsy/branch/master/graph/badge.svg)](https://codecov.io/gh/startz/oauth2-etsy)

![Packagist Downloads](https://img.shields.io/packagist/dt/startz/oauth2-etsy)

This package provides Etsy OAuth 2.0 support for the PHP League's [OAuth 2.0 Client](https://github.com/thephpleague/oauth2-client).

## Requirements

The following versions of PHP are supported.

* PHP 7.3

* PHP 7.4

* PHP 8.0

## Installation

To install, use composer:

```

composer require startz/oauth2-etsy

```

## Usage

Usage is the same as The League's OAuth client, using `\StartZ\OAuth2\Client\Provider\Etsy` as the provider.

Please refer to your [Etsy Developer Account](https://www.etsy.com/developers/your-apps) for the necessary settings.

### Authorization Code Flow

```php

 '{etsy-apikey-keystring}',

    'clientSecret' => '{etsy-apikey-shared-secret}',

    'redirectUri'  => 'https://example.com/callback-url',

]);

if ( ! isset($_GET['code'])) 

{

    // If we don't have an authorization code then get one

    $preChallenge = $provider->getPreChallenge();

    $authUrl = $provider->getAuthorizationUrl([

        'code_challenge' => $provider->getPKCE($preChallenge),

        'code_challenge_method' => 'S256'

    ]);

    $_SESSION['oauth2state'] = $provider->getState();

    $_SESSION['oauth2code'] = $preChallenge;

    header('Location: ' . $authUrl);

    exit;

// Check given state against previously stored one to mitigate CSRF attack

} elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) {

    unset($_SESSION['oauth2state']);

    unset($_SESSION['oauth2code']);

    exit('Invalid state');

} else {

    

    $preChallenge = $_SESSION['oauth2code'];

    $authParams = [

        'code' => $_GET['code'],

        'code_verifier' => $preChallenge,

    ];

    // Try to get an access token (using the authorization code grant)

    $token = $provider->getAccessToken('authorization_code', $authParams);

    // Optional: Now you have a token you can look up a users profile data

    try {

        // We got an access token, let's now get the user's details

        $user = $provider->getResourceOwner($token);

        printf('Hello %s!', $user->getName());

    } catch (Exception $e) {

        // Failed to get user details

        exit('Error...');

    }

    // Use this to interact with an API on the users behalf

    echo $token->getToken();

}

```

## Testing

Unit Tests

``` bash

$ ./vendor/bin/phpunit

```

Code Sniff

```bash

$ ./vendor/bin/phpcs src --standard=psr2 -sp

```