Skip to content

Latest commit

 

History

History
162 lines (112 loc) · 4.44 KB

README_OAUTHV1_TO_OAUTHV2.md

File metadata and controls

162 lines (112 loc) · 4.44 KB
Raw

Migrating from OAuth 1.0 to OAuth 2.0

Automatic migration (auto-migrate existing OAuth 1.0 tokens to OAuth 2.0 tokens)

@todo

Manual migration (have people re-connect manually to get OAuth 2.0 tokens)

  1. Make a backup of your code
  2. Make a backup of your existing OAuth v1.0 tokens
  3. git clone the repository to get the new code
  4. Make code changes as detailed below
  5. Go get your Client ID and Client Secret from developer.intuit.com for your app

Code change - IntuitAnywhere constructor

This constructor for the QuickBooks_IPP_IntuitAnywhere class has changed.

Anywhere you see this:

new QuickBooks_IPP_IntuitAnywhere($dsn, $encryption_key, $oauth_consumer_key, $oauth_consumer_secret, $quickbooks_oauth_url, $quickbooks_success_url);

Needs to change to this (note the new parameters):

new QuickBooks_IPP_IntuitAnywhere(QuickBooks_IPP_IntuitAnywhere::OAUTH_V2, $sandbox, $scope, $dsn, $encryption_key, $oauth_client_id, $oauth_client_secret, $quickbooks_oauth_url, $quickbooks_success_url);

$scope can be 'com.intuit.quickbooks.accounting', 'com.intuit.quickbooks.payment', or 'com.intuit.quickbooks.accounting com.intuit.quickbooks.payment' for access to both.

Database changes

ALTER TABLE `quickbooks_oauth`
RENAME TO `quickbooks_oauthv1`;

ALTER TABLE `quickbooks_oauthv1`
CHANGE `quickbooks_oauth_id` `quickbooks_oauthv1_id` int(10) unsigned NOT NULL AUTO_INCREMENT FIRST;

CREATE TABLE `quickbooks_oauthv2` (
  `quickbooks_oauthv2_id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `app_tenant` varchar(255) NOT NULL,
  `oauth_state` varchar(255) DEFAULT NULL,
  `oauth_access_token` text,
  `oauth_refresh_token` text,
  `oauth_access_expiry` datetime DEFAULT NULL,
  `oauth_refresh_expiry` datetime DEFAULT NULL,
  `qb_realm` varchar(32) DEFAULT NULL,
  `request_datetime` datetime NOT NULL,
  `access_datetime` datetime DEFAULT NULL,
  `last_access_datetime` datetime DEFAULT NULL,
  `last_refresh_datetime` datetime DEFAULT NULL,
  `touch_datetime` datetime DEFAULT NULL,
  PRIMARY KEY (`quickbooks_oauthv2_id`)
);

Code change - IntuitAnywhere->load(...)

The ->load(...) method has changed, dropping the $the_username parameter. Where you see this:

$creds = $IntuitAnywhere->load($the_username, $the_tenant);

Change it to this:

$creds = $IntuitAnywhere->load($the_tenant);

Code change - IntuitAnywhere->check(...)

The ->check(...) method has changed, dropping the $the_username parameter. Change:

if ($IntuitAnywhere->check($the_username, $the_tenant)

To this:

if ($IntuitAnywhere->check($the_tenant)

Code change - IntuitAnywhere->test(...)

The ->test(...) method has changed, dropping the $the_username parameter. Change:

$IntuitAnywhere->test($the_username, $the_tenant))

To this:

$IntuitAnywhere->test($the_tenant))

Code change - IntuitAnywhere->handle(...)

The ->handle(...) method has changed, dropping the $the_username parameter. Change:

$IntuitAnywhere->handle($the_username, $the_tenant))

To this:

$IntuitAnywhere->handle($the_tenant))

Code change - IntuitAnywhere->expiry(...), IntuitAnywhere->reconnect(...), IntuitAnywhere->disconnect(...)

Calls to the ->expiry(...), ->reconnect(...), and ->disconnect(...) methods are no longer necessary. OAuthV2 token refreshes are done automatically before every API call if the time-to-live of the Access Token is less than 60 seconds. Also, calls to these methods will fail, as they call the old ->oauthLoad(...) method, which no longer exists in the drivers (it has been updated to ->oauthLoadV1(...) and ->oauthLoadV2(...)). See #269 and #271 for discussion.

Code change - IPP->authMode(...)

The parameters to the ->authMode(...) method have changed. Change:

$IPP->authMode(
    QuickBooks_IPP::AUTHMODE_OAUTH,
    $creds);

To this:

$IPP->authMode(
    QuickBooks_IPP::AUTHMODE_OAUTHV2,
    $creds);

Code change - QuickBooks_IPP(...) constructor

The QuickBooks_IPP(...) constructor needs an additional parameter. Change this:

// Set up the IPP instance
$IPP = new QuickBooks_IPP($dsn);

To this:

// Set up the IPP instance
$IPP = new QuickBooks_IPP($dsn, $encryption_key);

Reconnect

  1. Disconnect from QuickBooks (or clear your token from the quickbooks_oauthv1 SQL table).
  2. Reconnect to QuickBooks (you should see a slightly different OAuth process, and see entries appear in the quickbooks_oauthv2 SQL table).