(PureBasic) 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 PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttpRequest.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "2498righ8wr6aihe98rt8rhowirtyw9er6twe80rtywrehrt")
    CkHttp::setCkPassword(http, "nerf254578uh8rgt7y3h57358ouyth387h8h53h6yyh80hh578per9y7u5ruyuy4")

    req.i = CkHttpRequest::ckCreate()
    If req.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpRequest::ckAddParam(req,"grant_type","client_credentials")

    CkHttpRequest::ckAddHeader(req,"x-merchant-id","7B3027")

    resp.i = CkHttp::ckPostUrlEncoded(http,"https://wwwcie.ups.com/security/v1/oauth/token",req)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

    ; Save the OAuth2 access token for other examples to use.
    CkJsonObject::ckWriteFile(jResp,"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"
    ; }

    token_type.s = CkJsonObject::ckStringOf(jResp,"token_type")
    issued_at.s = CkJsonObject::ckStringOf(jResp,"issued_at")
    client_id.s = CkJsonObject::ckStringOf(jResp,"client_id")
    access_token.s = CkJsonObject::ckStringOf(jResp,"access_token")
    expires_in.s = CkJsonObject::ckStringOf(jResp,"expires_in")
    status.s = CkJsonObject::ckStringOf(jResp,"status")


    CkHttp::ckDispose(http)
    CkHttpRequest::ckDispose(req)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure