Generate an OAuth Token for the Track API

Note

Draft content. This page is a draft and is not yet complete.

HTTP Request

POST /oauth2/token

Summary

This API generates the OAuth token required for access to the Pitney Bowes Track API.

Prerequisite

Contact your Pitney Bowes implementation manager for credentials for the Track API.

Considerations

  • The POST operation does not require a payload.

  • Each authorization token is valid for 60 minutes.

  • It is recommended you reuse the valid token until it expires.

Request URLs

Production: https://auth.tracking.pitneybowes.com/oauth2/token

Query Parameters

Name

Description

grant_type

Required. Set this to: client_credentials

client_id

Required. The client ID received from your PB implementation manager.

client_secret

Required. The client secret received from your PB implementation manager.

scope

Required. Set this to: utp/track

Request Headers

Name


Description

Content-Type

Required. Set this to: x-www-form-urlencoded

x-api-key

Required. Set this to the x-api-key received from your PB implementation manager.

Response Elements

Name

Data Type

Description


 


 

Sample Request

curl -X POST .../oauth2/token?grant_type=client_credentials&client_id={clientId}&client_secret={clientSecret}&scope=utp/track \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "x-api-key: <x-api-key>"

Sample Response