README.md

oauth2-getresponse

This package implements a GetResponse OAuth 2.0 provider for thephpleague/oauth2-client library.

Installation

Recommended way to install the package is by using composer:

composer require getresponse/oauth2-getresponse

Usage

Basic provider construction:

<?php

$provider = new \Getresponse\Oauth\Provider\Getresponse([
    'clientId' => 'CLIENT-ID',
    'clientSecret' => 'CLIENT-SECRET'
]);

It's also possible to set a custom domain and an API endpoint, which is useful when authorizing GetResponse 360 customers:

<?php

$provider = new \Getresponse\Oauth\Provider\Getresponse([
    'clientId' => 'CLIENT-ID',
    'clientSecret' => 'CLIENT-SECRET',
    'domain' => 'https://custom-domain.getresponse360.com',
    'apiEndpoint' => 'https://api3.getresponse360.com'
]);

Please refer to the oauth2-client documentation for a full OAuth 2.0 flow example.

Documentation

• GetResponse API Docs
• GetResponse OAuth 2.0 Reference
• The PHP League's oauth2-client

Running tests

To run unit tests, issue the following commands:

composer install
php vendor/bin/phpunit