Get Started
Welcome to the V3NITY PAAS API Documentation. Our platform provides a robust engine for logistics, asset management, and route optimization.
Authentication
To access our API services, you need a valid security pass. We support three primary authentication methods depending on your integration use case:
1. Access Token
Call the login endpoint to authenticate and receive both an access token and a refresh token. Ideal for mobile or web applications that require user-level authentication.
2. Persistent Token
Long-lived tokens obtained via the admin portal. Best for server-to-server data exchange where interactive login is not practical. Requires IP whitelisting for enhanced security.
3. API Key
Short, fixed-length keys (16-32 chars) designed for hardware devices or environments with strict header size limitations.
Security Pass Usage
Every API request must include the Authorization header. The format depends on the token type used:
Bearer Authentication (Tokens)
Include the BEARER keyword followed by your JWT or Persistent token.
Authorization: BEARER eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9...API Key Authentication
Provide the API key directly without the Bearer prefix.
Authorization: CNV004L45K5PMZ15ZSQZDA78EJ5CIV0GResources
For detailed implementation guides and security best practices, please refer to our authentication guide:
View Authentication Guide