Dart

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

import 'package:chilkat/chilkat.dart';

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

  final http = CkHttp();

  // 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';

  final req = CkHttpRequest();
  req.addParam('grant_type', 'client_credentials');

  req.addHeader('x-merchant-id', '7B3027');

  req.httpVerb = 'POST';
  req.contentType = 'application/x-www-form-urlencoded';

  final resp = CkHttpResponse();
  try {
    http.httpReq('https://wwwcie.ups.com/security/v1/oauth/token', req, resp);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final sbResponseBody = CkStringBuilder();
  resp.getBodySb(sbResponseBody);

  final jResp = CkJsonObject();
  jResp.loadSb(sbResponseBody);
  jResp.emitCompact = false;

  print('Response Body:');
  print(jResp.emit());

  final respStatusCode = resp.statusCode;
  print('Response Status Code = $respStatusCode');
  if (respStatusCode >= 400) {
    print('Response Header:');
    print(resp.header);
    print('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"
  // }

  final tokenType = jResp.stringOf('token_type');
  final issuedAt = jResp.stringOf('issued_at');
  final clientId = jResp.stringOf('client_id');
  final accessToken = jResp.stringOf('access_token');
  final expiresIn = jResp.stringOf('expires_in');
  final status = jResp.stringOf('status');
}