timenomad/getresponse-v3-api

A PHP wrapper for the GetResponse V3 API, supporting OAuth2 authorization flow

Maintainers

Details

github.com/timenomad/GetResponseV3Api

Homepage

Source

Issues

Installs: 222

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

1.1.0 2016-05-23 11:51 UTC

Requires

  • php: >=5.3.0
  • ext-curl: *

GNU GPLv3 e63f951ad6a0baa9f464d1d27cd27eae10c0cf22

oauth2getresponse

This package is not auto-updated.

Last update: 2024-05-08 22:21:45 UTC

README

A read-only PHP wrapper for the GetResponse V3 API, supporting OAuth2 authorization flow.

Create GetResponse App

  • You need to create an app here: https://app.getresponse.com/manage_api.html (Third party applications)
  • Note the Client ID & Client Secret, you will need them.
  • Set Redirect URL to your web app's route responsible for fetching the access token, after user approves to grant your app access.

Usage

  • Install via composer: composer require timenomad/getresponse-v3-api
  • Init API object: $getResponse = new \Timenomad\GetResponseV3Api("*Client ID*", "*Client Secret*", "*State*");.
    State is just a random combination of characters, to validate callback's origin. It's a static value.
    An example would be: fdsfjhs3SDGg23refsd2u09@$
  • Get OAuth2 user consent URL: $getResponse->getOAuthConsentUrl()
  • When user approves and your callback URL is called: $accessToken = $getResponse->getAccessToken();
  • Store the token in your storage engine
  • Having the token, we can now configure the authentication and begin calling the API:
    $getResponse->setAccessToken($token['access_token']);
    $getResponse->setAccessTokenExpiryCallback($token['refresh_token'], function($newTokenData) {
    // Access Token expired. This function will be called after a new token has been generated.
    // Here you can save the new token data to the database, or any other storage means.
    });
  • We can now call the API!
    $userInfo = $getResponse->getAccountInfo();
    $campaigns = $getResponse->getCampaigns();
    $statistics = $getResponse->getCampaignStatistics();

SSL Verification

For development purposes, it can be handy to disable curl's SSL certificate verification, to do so, instantiate the API wrapper object like so (4th param sets to bypass verfification):

GetResponseV3Api(x, y, z, true)