You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-15Lines changed: 4 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,24 +1,16 @@
1
1
# USPS API
2
2
The USPS Developer Portal is for software developers who would like to integrate Postal Service functionality into their ecommerce, shipping, or logistics systems. Access and use USPS tools and resources conveniently within your site or application. You have the ability to try out the APIs in our Test environment.
3
3
4
-
## Getting Started in Test Environment
5
-
To use the USPS APIs in the Test Environment you must be a registered user.
6
-
1. Apply for a free USPS.com account.
7
-
2. Access the [USPS Test (CAT) Business Customer Gateway](https://gateway-cat.usps.com/eAdmin/view/signin) and follow the prompts to create a USPS.com business account.
8
-
3. Using your USPS account, access the [USPS Test (CAT) Developer Portal](https://developers-cat.usps.com) by clicking the Sign Up / Login link.
9
-
4. Registering your application and retrieve your consumer key and consumer secret from the credential section.
10
-
5. Additionally you will need to have a Customer ID (CRID) and Mailer ID (MID)
11
-
12
-
## Getting Started in Production
13
-
To use the USPS APIs you must be a registered user.
4
+
## Getting Started
5
+
To use the USPS APIs in Production and the Test Environment you must be a registered user.
14
6
1. Apply for a free USPS.com account.
15
7
2. Access the [Business Customer Gateway](https://gateway.usps.com/eAdmin/view/signin) and follow the prompts to create a USPS.com business account.
16
8
3. Using your USPS account, access the [USPS Developer Portal](https://developers.usps.com) by clicking the Sign Up / Login link.
17
9
4. Registering your application and retrieve your consumer key and consumer secret from the credential section.
18
10
5. Additionally, you will need to have a Customer ID (CRID) and Mailer ID (MID)
19
11
20
12
## Using the APIs in the USPS Test Environment
21
-
All USPS APIs listed below are Production URL. To use the API in Test Environment you need to change the URL from https://apis.usps.com to https://apis-cat.usps.com.
13
+
All USPS APIs listed below are Production URL. To use the API in Test Environment you need to change the URL from https://apis.usps.com to https://apis-tem.usps.com.
22
14
23
15
## OAuth Token
24
16
Your exclusive access to USPS APIs is protected using OAuth 2.0 industry standards. All USPS APIs require an OAuth 2.0 access token to be conveyed in the `Authorization` header, using the `Bearer` token scheme. Once you sign-in to the API developer portal, you may get the OAuth credentials you will need to register your application `Add App`. See "Getting Started" for further information about signing-in, registering your application, and additional USPS account credentials you will need to integrate your application with USPS APIs. You are responsible for securing the application credentials once issued. Please contact USPS if your credentials have been disclosed to external parties and we will issue new credentials.
0 commit comments