USPS
Connect your client's USPS with a key they paste, and call its API through Operate As.
- Website
- usps.com
- Connects by
- Pasting a Consumer key
- Category
- Online stores
- Services
- 1
- Tools
- Pass-through only
| Service | Key | Base URL |
|---|---|---|
| USPS | usps | https://apis.usps.com |
Connecting
Your client makes a Consumer key in their USPS settings and pastes it on their link. Operate As tries it with USPS before saving it, and stores it encrypted. See Services connected with an API key.
curl https://api.operate.as/v1/me/clients \ -H "Authorization: Bearer $OPERATE_AS_API_KEY"[ { "id": "6f1c2a7e-...", "name": "Miller Dental", "services": [ "usps" ] }]Permissions
| What the client reads | Permission it asks for |
|---|---|
| Use the USPS key you paste, with only the access you gave that key | Chosen on the provider's screen |
Pass-through
USPS has no ready-made tools yet. Call any endpoint of its API through Operate As instead, with the client's access attached.
Add the client
In Clients, add your client and select USPS. Then send them their link.
Your client connects
They paste a Consumer key from their USPS settings.
Find the endpoint
Pick the call from USPS's own API docs. Your path is everything after https://apis.usps.com.
Send it through Operate As
Use the client's ID, the service key usps and that path. Your Operate As key goes in Authorization; the client's access is added for you.
See Pass-through requests for the full request and response format.
curl "https://api.operate.as/v1/clients/6f1c2a7e-.../usps/addresses/v3/city-state?ZIPCode=10001" \ -H "Authorization: Bearer $OPERATE_AS_API_KEY"{ "status": 200, "data": { "…": "the service's own response" }, "encoding": "json"}When access ends
A key works until your client deletes it in USPS. They can paste a new one on the same link at any time, and your workflows carry on without changes.
See Keeping access alive and Removing access.
{ "status": 401, "data": { "…": "the service's own error" }, "encoding": "json"}