Node.js

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). Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

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

    var http = new 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

    http.BasicAuth = true;
    http.Login = "2498righ8wr6aihe98rt8rhowirtyw9er6twe80rtywrehrt";
    http.Password = "nerf254578uh8rgt7y3h57358ouyth387h8h53h6yyh80hh578per9y7u5ruyuy4";

    var req = new chilkat.HttpRequest();
    req.AddParam("grant_type","client_credentials");

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

    req.HttpVerb = "POST";
    req.ContentType = "application/x-www-form-urlencoded";

    var resp = new chilkat.HttpResponse();
    success = http.HttpReq("https://wwwcie.ups.com/security/v1/oauth/token",req,resp);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = resp.StatusCode;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(resp.Header);
        console.log("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"
    // }

    var token_type = jResp.StringOf("token_type");
    var issued_at = jResp.StringOf("issued_at");
    var client_id = jResp.StringOf("client_id");
    var access_token = jResp.StringOf("access_token");
    var expires_in = jResp.StringOf("expires_in");
    var status = jResp.StringOf("status");

}

chilkatExample();