(Visual FoxPro) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loHttp
LOCAL lnSuccess
LOCAL loReq
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcToken_type
LOCAL lcIssued_at
LOCAL lcClient_id
LOCAL lcAccess_token
LOCAL lcExpires_in
LOCAL lcStatus

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('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

loHttp.BasicAuth = 1
loHttp.Login = "2498righ8wr6aihe98rt8rhowirtyw9er6twe80rtywrehrt"
loHttp.Password = "nerf254578uh8rgt7y3h57358ouyth387h8h53h6yyh80hh578per9y7u5ruyuy4"

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.HttpRequest')
loReq = CreateObject('Chilkat.HttpRequest')
loReq.AddParam("grant_type","client_credentials")

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

loResp = loHttp.PostUrlEncoded("https://wwwcie.ups.com/security/v1/oauth/token",loReq)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loReq
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loReq
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* Save the OAuth2 access token for other examples to use.
loJResp.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"
* }

lcToken_type = loJResp.StringOf("token_type")
lcIssued_at = loJResp.StringOf("issued_at")
lcClient_id = loJResp.StringOf("client_id")
lcAccess_token = loJResp.StringOf("access_token")
lcExpires_in = loJResp.StringOf("expires_in")
lcStatus = loJResp.StringOf("status")

RELEASE loHttp
RELEASE loReq
RELEASE loSbResponseBody
RELEASE loJResp