🚀 Alotech Public API: A Transition from v2 to v3

Alotech will change the structure of its Public API,moving from version 2 to version 3. This transition brings significant changes in authentication methods and the structure of request parameters and responses. Here, we will delve into the key differences and improvements between Public API v2 and v3.

🔐 Authentication: From App Token to Client Credentials

API v2: App Token

In the previous version (API v2), authentication was handled using an app token. Each application was required to include this token in the request headers to authenticate and authorize API calls.

API v3: Client Credentials

With API v3, Alotech has shifted to using client credentials for authentication. This method involves obtaining an access token by providing client ID and client secret, which is then used for making API requests. This change enhances security and aligns with industry best practices.

Steps to Authenticate with Client Credentials:
1.Obtain Access Token
2.Use Access Token in Requests

Tip: You can access the Client Credentials document via the link. Client Credentials

📝 Request Parameters and Responses

API v2: Legacy Structure

The structure of request parameters and responses in API v2 was more rigid and less intuitive, often requiring additional processing on the client side to parse and utilize the data effectively.

Note: The legacy structure could lead to higher overhead for client applications.

API v3: Enhanced Structure

API v3 introduces a more streamlined and user-friendly approach to request parameters and responses. The data is now more structured, making it easier to work with and reducing the overhead on client applications.

Tip: The new structure provides more intuitive and consistent parameters, making integration smoother.

📚 Learn More: For a comprehensive list of changes between Public API v2 and v3, visit our API Comparison list.

📊 Summary of Improvements

Authentication: Enhanced security with client credentials replacing app tokens.
Request Parameters: More intuitive and consistent parameters.
Responses: Improved data structure for easier integration and reduced client-side processing.

⚠️ Warning: Ensure your applications are updated to use the new authentication method and request/response structures.

The transition from API v2 to API v3 marks a significant step forward in providing a more secure, efficient, and developer-friendly experience. Alotech is committed to continuous improvement and ensuring that our APIs meet the highest standards of performance and usability.

✅ Success: For detailed documentation and examples, please refer to the Alotech API Documentation.