(Java) 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 Java Downloads Java Libs for Windows, MacOS, Linux, Alpine Linux, Solaris Java Libs for Android

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();
    boolean success;

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

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

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

    CkHttpResponse resp = http.PostUrlEncoded("https://wwwcie.ups.com/security/v1/oauth/token",req);
    if (http.get_LastMethodSuccess() == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    System.out.println("Response Body:");
    System.out.println(jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    System.out.println("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        System.out.println("Response Header:");
        System.out.println(resp.header());
        System.out.println("Failed.");

        return;
        }

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

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