AppXite News 03-07-2023
AppXite API News
We are thrilled to announce a series of API improvements that will enhance your integration experience and empower you to deliver even greater value to your partners. Our latest updates introduce new APIs and advanced features aimed at streamlining user management, providing access to add-ons, enhancing order management capabilities, and optimizing performance through caching.
This tool provides efficient onboarding and managing of users in bulk, ensures data integrity while maintaining an updated list of active users on your platform, bolsters security, and enables analytics. Gain a centralized view of user information for streamlined administration.
It provides a convenient way to add text-based notes to orders. Enhance your order management system by including additional information such as special instructions, customer details, or any other relevant data. These notes will be visible to all users with access to the order.
Seamlessly retrieve add-ons for your offers programmatically, allowing you to integrate platform catalogs into your marketplace effortlessly.
Retrieve subscription add-on details, including IDs, quantities, names, and metering information. Make changes to add-ons and update subscriptions seamlessly.
API Caching for Faster and Scalable Performance
We are excited to introduce API cache functionality for our GET requests, delivering enhanced performance and scalability to your integrations. By leveraging our default caching policy or customizing it to suit your specific needs, you can experience faster response times and provide a smoother user experience. One of the key benefits of the caching implementation is its flexibility, as you can tailor the caching behavior to suit your integration needs by utilizing optional headers, enabling you to adjust caching parameters as desired.
To implement caching in your integration, follow these simple steps:
- Enable Cache. Include the "X-Use-Cache" header in your GET requests to enable or disable caching for specific requests. Set the header value to "true" to enable caching or "false" to disable it.
- Specify Cache Duration. Use the "X-Cache-Duration" header to define the time period in milliseconds for which a response will be cached.
By enabling caching, subsequent requests with the "X-Use-Cache" header set to "true" will benefit from cached responses, eliminating redundant data retrieval and significantly improving performance. Learn more →
Key Benefits of API Caching:
Improved Scalability. Our APIs can now handle higher request volumes and increased traffic while maintaining excellent performance. By reducing the load on backend resources, your integrations remain responsive and scalable.
Consistent API Performance. Enjoy stable response times across various usage scenarios, providing a reliable user experience. With caching, you can maintain consistent performance levels even during peak usage periods, ensuring a seamless and responsive integration experience.
We have introduced the X-ApiUser header in our "Create an Order" API, allowing you to accurately attribute orders within the AppXite Platform.
For example, let's say you are using a dedicated API account for your integration with the AppXite Platform. As a result, in the "Created by" column of the Order section, you would see only the name of that API account. However, you may want to attribute orders to specific users in your ERP/Marketplace. With the introduction of the X-ApiUser header in our "Create an Order" API, you can now pass the user information from your ERP/Marketplace, making it visible in the "Created by" column. This allows you to accurately attribute orders to individual users and retrieve them using the "List all orders" functionality, providing better transparency and user recognition within the platform.