(VB.NET) 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.

IMPORTANT: This example requires a pre-release for the next version of Chilkat after the current v9.5.0.99 release. Contact info@chilkatsoft.com if you wish to get a pre-release. However, pre-releases of .NET Core (hosted on NuGet) and Node.js will not be possible.

For more information, see https://partner.tiktokshop.com/doc/page/63fd743c715d622a338c4e54

Chilkat .NET Downloads Chilkat .NET Framework Chilkat for .NET Core

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

Dim oauth2 As New Chilkat.OAuth2
Dim success As Boolean

' 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.
oauth2.ListenPort = 3017

oauth2.AuthorizationEndpoint = "https://services.tiktokshop.com/open/authorize"
oauth2.TokenEndpoint = "https://auth.tiktok-shops.com/api/v2/token/get"

' Replace these with actual values.
oauth2.ClientId = "APP_KEY"
oauth2.ClientSecret = "APP_SECRET"

oauth2.Scope = ""

' 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.
oauth2.AddAuthQueryParam("service_id","YOUR_SERVICE_ID")

' Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
Dim url As String = oauth2.StartAuth()
If (oauth2.LastMethodSuccess <> True) Then
    Debug.WriteLine(oauth2.LastErrorText)
    Exit Sub
End If


' -------------------------------------------------------------------
' IMPORTANT:
' At this point, your application should load the URL in a browser.
' For example, 
' in C#: System.Diagnostics.Process.Start(url);
' in Java: Desktop.getDesktop().browse(new URI(url));
' in VBScript: Set wsh=WScript.CreateObject("WScript.Shell")
'              wsh.Run url
' in Xojo: ShowURL(url)  (see http://docs.xojo.com/index.php/ShowURL)
' in Dataflex: Runprogram Background "c:\Program Files\Internet Explorer\iexplore.exe" sUrl
' in C++ on Windows: ShellExecute(0, 0, url, 0, 0 , SW_SHOW );

' Add the code to load the url in a web browser here...
' Add the code to load the url in a web browser here...
' Add the code to load the url in a web browser here...


' Now wait for the authorization.
' We'll wait for a max of 60 seconds.
Dim numMsWaited As Integer = 0
While (numMsWaited < 60000) And (oauth2.AuthFlowState < 3)
    oauth2.SleepMs(100)
    numMsWaited = numMsWaited + 100
End While

' 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 (oauth2.AuthFlowState < 3) Then
    oauth2.Cancel()
    Debug.WriteLine("No response from the browser!")
    Exit Sub
End If



' 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 (oauth2.AuthFlowState = 5) Then
    Debug.WriteLine("OAuth2 failed to complete.")
    Debug.WriteLine(oauth2.FailureInfo)
    Exit Sub
End If


If (oauth2.AuthFlowState = 4) Then
    Debug.WriteLine("OAuth2 authorization was denied.")
    Debug.WriteLine(oauth2.AccessTokenResponse)
    Exit Sub
End If


If (oauth2.AuthFlowState <> 3) Then
    Debug.WriteLine("Unexpected AuthFlowState:" & oauth2.AuthFlowState)
    Exit Sub
End If


Debug.WriteLine("OAuth2 authorization granted!")
Debug.WriteLine("Access Token = " & oauth2.AccessToken)

' Get the full JSON response:
Dim json As New Chilkat.JsonObject
json.Load(oauth2.AccessTokenResponse)
json.EmitCompact = 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......"
' }


Debug.WriteLine(json.Emit())

' How to get values from the JSON:
Dim strVal As String

Dim code As Integer = json.IntOf("code")
Dim message As String = json.StringOf("message")
Dim Access_token As String = json.StringOf("data.access_token")
Dim Access_token_expire_in As Integer = json.IntOf("data.access_token_expire_in")
Dim Refresh_token As String = json.StringOf("data.refresh_token")
Dim Refresh_token_expire_in As Integer = json.IntOf("data.refresh_token_expire_in")
Dim Open_id As String = json.StringOf("data.open_id")
Dim Seller_name As String = json.StringOf("data.seller_name")
Dim Seller_base_region As String = json.StringOf("data.seller_base_region")
Dim User_type As Integer = json.IntOf("data.user_type")
Dim request_id As String = json.StringOf("request_id")
Dim i As Integer = 0
Dim count_i As Integer = json.SizeOfArray("data.granted_scopes")
While i < count_i
    json.I = i
    strVal = json.StringOf("data.granted_scopes[i]")
    i = i + 1
End While


' Save the JSON to a file for future requests, if needed..
Dim fac As New Chilkat.FileAccess
fac.WriteEntireTextFile("qa_data/tokens/tiktok-shops.json",json.Emit(),"utf-8",False)