The Quable SDK: an introduction
18 January 2024
What is an SDK? SDK stands for Software Development Kit, and in practical terms it is a set of tools designed to speed up the development of new applications and integrations.
At Quable, we have developed a bespoke SDK tailored to the needs and requirements of technology partners, integrators and users of the PIM solution.
The Quable PIM SDK is organised around six modules.
Quable Partner
The Quable Partner module is a portal designed for integration and/or technology partners who wish to create applications linked to the Quable PIM. As a partner, the module allows you to:
- Manage your Quable PIM instances,
- Create and test Quable applications,
- Deploy your applications to production,
- Manage your integration team,
- Set up a Stripe payment account,
- Monitor your applications’ activity (installation, payments, errors, etc.).
You can access it via this link: https://partners.quable.io
And find the full documentation here: https://developers.quable.com/quable-ecosystem/portal-partner/
We turned to the Qualifio Studio for a time-pressured campaign around a big event. Though Qualifio makes it easy to create interactive content independently, we have found that the responsiveness and expert insights of the Studio Team allows us to save time, develop a game tailored to our needs, and benefit from a daily follow up. They have very reasonable prices as well!
Quable API Clients
This is a set of libraries for integrators working with the PIM without being connected to it, intended for all integrators who interact with and manipulate the PIM without being logged in. It comprises pre-written classes and functions in a specific programming language. All of this is designed to simplify access to and interaction with an external API.
We provide two essential tools:
- quable-pim-js, for performing operations on the Quable PIM API for the available endpoints. The library is available from the following NPM repository: https://www.npmjs.com/package/@quable/quable-pim-js
- - quable-partner-js: for performing operations on the Quable Portal API for the available endpoints. Available via this link: https://www.npmjs.com/package/@quable/quable-partner-js
PIM Data Aggregator
Many customers find themselves rewriting the same code every time they want to extract data from the PIM. The PIM Data Integrator module simplifies data extraction from the Quable PIM via export files (media, product links, products, variants). The module aggregates this data to generate consolidated product files in JSON format. This data is more practical and suitable for marketplaces and e-commerce platforms.
Find the full documentation for the PIM Data Aggregator here: https://developers.quable.com/quable-ecosystem/pim-data-aggregator/
Quable App Kit
The Quable App Kit provides two sub-modules:
- Quable CLI offers efficient, scriptable and lightweight solutions for various tasks, with commands for creating and running Quable applications. Full documentation here: https://www.npmjs.com/package/@quable/quable-cli
- Quable App Template is an application template that makes developers’ work easier by providing security and session management mechanisms, thereby saving them time. Find the documentation here: https://github.com/quable/quable-app-template
Documentation
The SDK comes with clear, comprehensive and detailed documentation, as well as video tutorials, which are essential for understanding our tools and enabling you to:
- Access our guidance on how to use the SDK effectively.
- Speed up the integration process and minimise the learning curve for newcomers.
- Cater to different learning preferences with written and visual resources.
Quable Billing
This is an easy-to-use module for securely processing payments within your app, made possible through our partnership with Stripe.
The module provides a method for both recurring and one-off payments, whilst offering a high level of customisation, such as payment volume options. This means Quable partners can manage billing directly using this module.
Find the full documentation here: https://developers.quable.com/quable-ecosystem/quable-billing/
Interested in the Quable SDK? Become a Quable PIM partner!