(PHP Extension) Wish for Merchants -- Get OAuth2 Access Token for Desktop App

Demonstrates how to get a Wish for Merchants OAuth2 access token from a desktop application or script.

Note: This example requires Chilkat v10.1.2 or greater.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

// To further clarify, see OAuth 2.0 Authorization Flow

// This example is for desktop applicatons (it is not for code that runs on a web server).

// This is the way to initially obtain the OAuth2 access token.  Afterwards it can be 
// repeatedly refreshed without user interaction, as shown in this example: Refresh Wish OAuth2 Access Token.

$oauth2 = new CkOAuth2();

// Wish OAuth2 does not allow a localhost callback URI such as "http://localhost:<portNumber>/"
// For a desktop app, you must provide a script on your web server to redirect to "http://localhost/<portNumber>"

// Your applicaton must use your own public web server as an intermediate
// to receive and forward the redirect to localhost.
// See Using Your Web Server as an Intermediary for OAuth2 Redirect to localhost
$oauth2->put_AppCallbackUrl('https://yourwebserver.com/OAuth2.php');
$oauth2->put_ListenPort(3017);

$oauth2->put_AuthorizationEndpoint('https://merchant.wish.com/v3/oauth/authorize');
$oauth2->put_TokenEndpoint('https://merchant.wish.com/api/v3/oauth/access_token');

$oauth2->put_UncommonOptions('EXCHANGE_CODE_FOR_TOKEN_USING_GET');

// Replace these with actual values.
$oauth2->put_ClientId('WISH-CLIENT-ID');
$oauth2->put_ClientSecret('WISH-CLIENT-SECRET');

$oauth2->put_Scope('');

// Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
$url = $oauth2->startAuth();
if ($oauth2->get_LastMethodSuccess() != true) {
    print $oauth2->lastErrorText() . "\n";
    exit;
}

print 'url = ' . $url . "\n";

// Launch the default browser on the system and navigate to the url.
// The LaunchBrowser method was added in Chilkat v10.1.2.
$success = $oauth2->LaunchBrowser($url);
if ($success == false) {
    print $oauth2->lastErrorText() . "\n";
    exit;
}

// Wait for the user to approve or deny authorization in the browser.
$numMsWaited = 0;
while (($numMsWaited < 90000) and ($oauth2->get_AuthFlowState() < 3)) {
    $oauth2->SleepMs(100);
    $numMsWaited = $numMsWaited + 100;
}

// If the browser does not respond within the specified time, AuthFlowState will be:
// 
// 1: Waiting for Redirect - The OAuth2 background thread is waiting for the browser's redirect request.
// 2: Waiting for Final Response - The thread is awaiting the final access token response.
// In either case, cancel the background task initiated by StartAuth.

if ($oauth2->get_AuthFlowState() < 3) {
    $oauth2->Cancel();
    print 'No response from the browser!' . "\n";
    exit;
}

// Check AuthFlowState to determine if authorization was granted, denied, or failed:
// 
// 3: Success - OAuth2 flow completed, the background thread exited, and the successful response is in AccessTokenResponse.
// 4: Access Denied - OAuth2 flow completed, the background thread exited, and the error response is in AccessTokenResponse.
// 5: Failure - OAuth2 flow failed before completion, the background thread exited, and error details are in FailureInfo.

if ($oauth2->get_AuthFlowState() == 5) {
    print 'OAuth2 failed to complete.' . "\n";
    print $oauth2->failureInfo() . "\n";
    exit;
}

if ($oauth2->get_AuthFlowState() == 4) {
    print 'OAuth2 authorization was denied.' . "\n";
    print $oauth2->accessTokenResponse() . "\n";
    exit;
}

if ($oauth2->get_AuthFlowState() != 3) {
    print 'Unexpected AuthFlowState:' . $oauth2->get_AuthFlowState() . "\n";
    exit;
}

// Save the full JSON access token response to a file.
$sbJson = new CkStringBuilder();
$sbJson->Append($oauth2->accessTokenResponse());
$sbJson->WriteFile('qa_data/tokens/wish.json','utf-8',false);

// The full JSON received looks like this:
// {
//   "message": "",
//   "code": 0,
//   "data": {
//     "access_token": "15af1c191c1243b029bc1660b5c08ce7",
//     "scopes": [
//       "epc:read",
//       "epc:write",
//       "fbs:read",
//       "fbs:write",
//       "fbw:read",
//       "fbw:write",
//       "infractions:read",
//       "infractions:write",
//       "insurance:read",
//       "insurance:write",
//       "loans:read",
//       "loans:write",
//       "merchant:read",
//       "merchant:write",
//       "notifications:read",
//       "notifications:write",
//       "orders:read",
//       "orders:write",
//       "payments:read",
//       "payments:write",
//       "penalties:read",
//       "penalties:write",
//       "product_boost:read",
//       "product_boost:write",
//       "products:read",
//       "products:write",
//       "ratings:read",
//       "ratings:write",
//       "returns:read",
//       "returns:write",
//       "tickets:read",
//       "tickets:write"
//     ],
//     "merchant_id": "5eb3f605178f5be2c784fa02",
//     "expiry_time": "2020-12-17T16:55:09.594+00:00",
//     "refresh_token": "55a38e44df674a1e859891624b2c4c23"
//   }
// }

print 'OAuth2 authorization granted!' . "\n";
print 'Access Token = ' . $oauth2->accessToken() . "\n";

?>