Introduction to the API documentation

Welcome to the Karanext API documentation.
This guide brings together all the information needed to activate the API, create applications, obtain access tokens, and integrate external services securely and efficiently.

This documentation is designed to help developers, integrators, and technical administrators to:

• Understand the overall authentication process;
• Activate the API in the ADMIN application;
• Create and configure applications with specific permissions;
• Request secure access tokens;
• Make API calls.

🔐 Security model overview

The platform uses a token-based authentication model.
Applications must use the endpoint POST

/token

and provide their credentials to obtain a token.

This token:

• Has a lifespan of 5 minutes.
• Must be included in every API request (Authorization: Bearer <token>).
• Is limited by the permissions defined when the application is created.

🧭 Integration flow overview

Here is the overall flow for using the API:

1. Activate the API in the ADMIN application
2. Create an API application and configure its permissions
3. Retrieve credentials (client_id, application_id, secret)
4. Request an access token via the endpoint POST

   /token

5. Use the token to make API requests
6. Renew the token every 5 minutes if necessary

🛠 Technical prerequisites

To use the API, you need:

• A Karanext account.
• Access to the ADMIN application with administrator permission.
• Your API access information.