Authentication - dis_core_foundation

Authentication overview

The Routing APIs supports the following authentication methods.

• Bearer Token (JWT): Recommended for production applications. Secure, time-limited tokens.

Choose the method that best fits your use case and security requirements.

Server endpoints

Use one of the server URLs defined in the OpenAPI specification for authenticated requests.

• https://api.cloud.precisely.com

Authorization requirements

This endpoint requires Bearer token authentication.

Bearer Token (JWT) authentication

What is a Bearer Token?

A Bearer Token is a JSON Web Token (JWT) that proves your identity to the API. It is time-limited and can be revoked, which makes it more secure than API keys.

When to use Bearer Tokens

• Production applications and services.
• Long-running applications that need to make API calls over time.
• Applications that require high security.
• Multi-tenant systems where you need to revoke access quickly.

How to use Bearer Tokens

Step 1: Obtain a Bearer Token.

Generate or request a Bearer token using the credential workflow provided for your account. Store it securely in environment variables, not in source code.

Step 2: Include the token in your request.

Authorization: Bearer YOUR_TOKEN_HERE

Token expiration and refresh

Bearer tokens expire after a set period. When a token expires, the API returns a 401 Unauthorized response. Generate a new token and retry your request.

Security best practices

• Never hardcode credentials. Store API keys and tokens in environment variables or secure vaults.
• Use HTTPS only when making API requests.
• Rotate credentials regularly.
• Limit scope to the least privileged credentials required for your use case.
• Monitor usage to detect unusual activity.
• Revoke compromised credentials immediately.

Troubleshooting authentication errors

401 Unauthorized

Cause: Invalid, expired, or missing authentication credentials.

Solution: Check that your token or API key is correct and has not expired. Generate a new token if needed.

403 Forbidden

Cause: Your credentials are valid but you do not have permission to access this API.

Solution: Verify that your subscription or account grants access to this API.

Invalid Authorization header

Cause: The Authorization header format is incorrect.

Solution: Verify the header format matches exactly: Authorization: Bearer TOKEN or Authorization: Apikey ENCODED_CREDENTIALS.