Overview
- The Optimum Parcel Auth API lets you manage authentication and authorization for your workspace. You can develop applications that securely integrate with Optimum Parcel, ensuring that access to sensitive billing, shipping, and agreement data is protected through industry-standard security protocols.
- View Doc →
The following figure shows the relationship between your Optimum Parcel app, the Optimum Parcel API, and Authentication.
Optimum Parcel App
Optimum Parcel’s authentication services give users the ability to manage API keys, secret credentials, and OAuth tokens, providing granular control over who accesses your data and how.
Optimum Parcel API
The REST API that allows users to request, refresh, and revoke access tokens from within your app.
Identity Verification
An app that uses Optimum Parcel Auth as the gatekeeper in order to validate the identity of every request to ensure it originates from a verified source.
Token Management
A system that maintains the lifecycle of all bearer tokens and API keys, handling expiration logic and scope enforcement inherent to individual integration sessions.
What can users do with the Optimum Parcel Auth API?
Users can use the Optimum Parcel Auth API to perform common workflows, such as:
- Generate a new access token using client credentials
- Refresh an expired OAuth token
- Revoke an active token to terminate a session immediately
- Validate the scope and permissions of a specific API key
- Integrate secure “Sign in with Optimum Parcel” flows
- Rotate client secrets for enhanced security
Authentication properties available to create, modify, update and delete through the Optimum Parcel Auth API:
- Access Tokens
- API Keys
- Client Credentials
- OAuth Scopes
- Refresh Tokens
