(Xojo Plugin) 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).

For more information, see https://developer.ups.com/api/reference?loc=en_US#tag/OAuthClientCredentials_other

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

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

Dim http As New Chilkat.Http
Dim success As Boolean

// 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"

Dim resp As Chilkat.HttpResponse
resp = http.PostUrlEncoded("https://wwwcie.ups.com/security/v1/oauth/token",req)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

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

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

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

// Save the OAuth2 access token for other examples to use.
success = 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
token_type = jResp.StringOf("token_type")
Dim issued_at As String
issued_at = jResp.StringOf("issued_at")
Dim client_id As String
client_id = jResp.StringOf("client_id")
Dim access_token As String
access_token = jResp.StringOf("access_token")
Dim expires_in As String
expires_in = jResp.StringOf("expires_in")
Dim status As String
status = jResp.StringOf("status")