Delphi DLL

TikTok Shop OAuth2

See more TikTok Shop Examples

Demonstrates how to get the initial OAuth2 access token for a TikTop Shop application. This is for desktop applications and scripts only. It is not for server-side code running on a web server. Delphi DLL

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, FileAccess, OAuth2, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
oauth2: HCkOAuth2;
url: PWideChar;
numMsWaited: Integer;
json: HCkJsonObject;
strVal: PWideChar;
code: Integer;
message: PWideChar;
Access_token: PWideChar;
Access_token_expire_in: Integer;
Refresh_token: PWideChar;
Refresh_token_expire_in: Integer;
Open_id: PWideChar;
Seller_name: PWideChar;
Seller_base_region: PWideChar;
User_type: Integer;
request_id: PWideChar;
i: Integer;
count_i: Integer;
fac: HCkFileAccess;

begin
success := False;

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

oauth2 := CkOAuth2_Create();

// This should be the port in the localhost callback URL for your app.  
// The callback URL would look like "http://localhost:3017/" if the port number is 3017.
CkOAuth2_putListenPort(oauth2,3017);

CkOAuth2_putAuthorizationEndpoint(oauth2,'https://services.tiktokshop.com/open/authorize');
CkOAuth2_putTokenEndpoint(oauth2,'https://auth.tiktok-shops.com/api/v2/token/get');

// Replace these with actual values.
CkOAuth2_putClientId(oauth2,'APP_KEY');
CkOAuth2_putClientSecret(oauth2,'APP_SECRET');

CkOAuth2_putScope(oauth2,'');

// See https://partner.tiktokshop.com/doc/page/63fd743c715d622a338c4e5a
// for information about how to manually get your service_id
// Once you have the service_id, it should not change.
CkOAuth2_AddAuthQueryParam(oauth2,'service_id','YOUR_SERVICE_ID');

// Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
url := CkOAuth2__startAuth(oauth2);
if (CkOAuth2_getLastMethodSuccess(oauth2) = False) then
  begin
    Memo1.Lines.Add(CkOAuth2__lastErrorText(oauth2));
    Exit;
  end;

// Launch the system's default browser navigated to the URL.
success := CkOAuth2_LaunchBrowser(oauth2,url);
if (success = False) then
  begin
    Memo1.Lines.Add(CkOAuth2__lastErrorText(oauth2));
    Exit;
  end;

// Now wait for the authorization.
// We'll wait for a max of 60 seconds.
numMsWaited := 0;
while (numMsWaited < 60000) and (CkOAuth2_getAuthFlowState(oauth2) < 3) do
  begin
    CkOAuth2_SleepMs(oauth2,100);
    numMsWaited := numMsWaited + 100;
  end;

// If there was no response from the browser within 30 seconds, then 
// the AuthFlowState will be equal to 1 or 2.
// 1: Waiting for Redirect. The OAuth2 background thread is waiting to receive the redirect HTTP request from the browser.
// 2: Waiting for Final Response. The OAuth2 background thread is waiting for the final access token response.
// In that case, cancel the background task started in the call to StartAuth.
if (CkOAuth2_getAuthFlowState(oauth2) < 3) then
  begin
    CkOAuth2_Cancel(oauth2);
    Memo1.Lines.Add('No response from the browser!');
    Exit;
  end;

// Check the AuthFlowState to see if authorization was granted, denied, or if some error occurred
// The possible AuthFlowState values are:
// 3: Completed with Success. The OAuth2 flow has completed, the background thread exited, and the successful JSON response is available in AccessTokenResponse property.
// 4: Completed with Access Denied. The OAuth2 flow has completed, the background thread exited, and the error JSON is available in AccessTokenResponse property.
// 5: Failed Prior to Completion. The OAuth2 flow failed to complete, the background thread exited, and the error information is available in the FailureInfo property.
if (CkOAuth2_getAuthFlowState(oauth2) = 5) then
  begin
    Memo1.Lines.Add('OAuth2 failed to complete.');
    Memo1.Lines.Add(CkOAuth2__failureInfo(oauth2));
    Exit;
  end;

if (CkOAuth2_getAuthFlowState(oauth2) = 4) then
  begin
    Memo1.Lines.Add('OAuth2 authorization was denied.');
    Memo1.Lines.Add(CkOAuth2__accessTokenResponse(oauth2));
    Exit;
  end;

if (CkOAuth2_getAuthFlowState(oauth2) <> 3) then
  begin
    Memo1.Lines.Add('Unexpected AuthFlowState:' + IntToStr(CkOAuth2_getAuthFlowState(oauth2)));
    Exit;
  end;

Memo1.Lines.Add('OAuth2 authorization granted!');
Memo1.Lines.Add('Access Token = ' + CkOAuth2__accessToken(oauth2));

// Get the full JSON response:
json := CkJsonObject_Create();
CkJsonObject_Load(json,CkOAuth2__accessTokenResponse(oauth2));
CkJsonObject_putEmitCompact(json,False);

// The JSON response looks like this:

// {
//   "code": 0,
//   "message": "success",
//   "data": {
//     "access_token": "GCP_3n......",
//     "access_token_expire_in": 1722342011,
//     "refresh_token": "GCP_hA......",
//     "refresh_token_expire_in": 4841467787,
//     "open_id": "_VIz.......",
//     "seller_name": "****",
//     "seller_base_region": "GB",
//     "user_type": 0,
//     "granted_scopes": [
//       "seller.authorization.info",
//       "seller.delivery.status.write",
//       "seller.product.basic",
//       "seller.order.info",
//       "seller.fulfillment.basic",
//       "seller.shop.info",
//       "seller.fulfillment.package.write",
//       "seller.product.write"
//     ]
//   },
//   "request_id": "20240723......"
// }

Memo1.Lines.Add(CkJsonObject__emit(json));

// How to get values from the JSON:

code := CkJsonObject_IntOf(json,'code');
message := CkJsonObject__stringOf(json,'message');
Access_token := CkJsonObject__stringOf(json,'data.access_token');
Access_token_expire_in := CkJsonObject_IntOf(json,'data.access_token_expire_in');
Refresh_token := CkJsonObject__stringOf(json,'data.refresh_token');
Refresh_token_expire_in := CkJsonObject_IntOf(json,'data.refresh_token_expire_in');
Open_id := CkJsonObject__stringOf(json,'data.open_id');
Seller_name := CkJsonObject__stringOf(json,'data.seller_name');
Seller_base_region := CkJsonObject__stringOf(json,'data.seller_base_region');
User_type := CkJsonObject_IntOf(json,'data.user_type');
request_id := CkJsonObject__stringOf(json,'request_id');
i := 0;
count_i := CkJsonObject_SizeOfArray(json,'data.granted_scopes');
while i < count_i do
  begin
    CkJsonObject_putI(json,i);
    strVal := CkJsonObject__stringOf(json,'data.granted_scopes[i]');
    i := i + 1;
  end;

// Save the JSON to a file for future requests, if needed..
fac := CkFileAccess_Create();
CkFileAccess_WriteEntireTextFile(fac,'qa_data/tokens/tiktok-shops.json',CkJsonObject__emit(json),'utf-8',False);

CkOAuth2_Dispose(oauth2);
CkJsonObject_Dispose(json);
CkFileAccess_Dispose(fac);

end;