Ruby

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). Ruby

require 'chilkat'

success = false

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

http = Chilkat::CkHttp.new()

# 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.put_BasicAuth(true)
http.put_Login("2498righ8wr6aihe98rt8rhowirtyw9er6twe80rtywrehrt")
http.put_Password("nerf254578uh8rgt7y3h57358ouyth387h8h53h6yyh80hh578per9y7u5ruyuy4")

req = Chilkat::CkHttpRequest.new()
req.AddParam("grant_type","client_credentials")

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

req.put_HttpVerb("POST")
req.put_ContentType("application/x-www-form-urlencoded")

resp = Chilkat::CkHttpResponse.new()
success = http.HttpReq("https://wwwcie.ups.com/security/v1/oauth/token",req,resp)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";
    exit
end

# 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"
# }

token_type = jResp.stringOf("token_type")
issued_at = jResp.stringOf("issued_at")
client_id = jResp.stringOf("client_id")
access_token = jResp.stringOf("access_token")
expires_in = jResp.stringOf("expires_in")
status = jResp.stringOf("status")