VB.NET

UPS OAuth2 Client Credentials

See more UPS Examples

Get an OAuth2 access token for the UPS REST API using the client credentials flow (no interactivity with a web browser required). VB.NET

Dim success As Boolean = False

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

Dim http As New Chilkat.Http

' Implements the following CURL command:

' curl -i -X POST \
'   -u 2498righ8wr6aihe98rt8rhowirtyw9er6twe80rtywrehrt:nerf254578uh8rgt7y3h57358ouyth387h8h53h6yyh80hh578per9y7u5ruyuy4 \
'   https://wwwcie.ups.com/security/v1/oauth/token \
'   -H 'Content-Type: application/x-www-form-urlencoded' \
'   -H 'x-merchant-id: 7B3027' \
'   -d grant_type=client_credentials

' Use the following online tool to generate HTTP code from a CURL command
' Convert a cURL Command to HTTP Source Code

http.BasicAuth = True
http.Login = "2498righ8wr6aihe98rt8rhowirtyw9er6twe80rtywrehrt"
http.Password = "nerf254578uh8rgt7y3h57358ouyth387h8h53h6yyh80hh578per9y7u5ruyuy4"

Dim req As New Chilkat.HttpRequest
req.AddParam("grant_type","client_credentials")

req.AddHeader("x-merchant-id","7B3027")

req.HttpVerb = "POST"
req.ContentType = "application/x-www-form-urlencoded"

Dim resp As New Chilkat.HttpResponse
success = http.HttpReq("https://wwwcie.ups.com/security/v1/oauth/token",req,resp)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(resp.Header)
    Debug.WriteLine("Failed.")
    Exit Sub
End If


' Save the OAuth2 access token for other examples to use.
jResp.WriteFile("qa_data/tokens/ups_oauth2_token.json")

' If successful, the OAuth2 access token JSON looks like this:

' {
'   "token_type": "Bearer",
'   "issued_at": "1686911985606",
'   "client_id": "2498righ8wr6aihe98rt8rhowirtyw9er6twe80rtywrehrt",
'   "access_token": "eyJraW......R2sbqrY",
'   "expires_in": "14399",
'   "status": "approved"
' }

Dim token_type As String = jResp.StringOf("token_type")
Dim issued_at As String = jResp.StringOf("issued_at")
Dim client_id As String = jResp.StringOf("client_id")
Dim access_token As String = jResp.StringOf("access_token")
Dim expires_in As String = jResp.StringOf("expires_in")
Dim status As String = jResp.StringOf("status")