Getting Started
This guide will help you get prepared and up to speed with using the BetterCommerce PIM API to integrate with your existing technology stack or enable you to build custom applications on top of the PIM APIs. We'll explain the process of making your initial API request and we'll direct you on where to proceed next to access all the information required for effectively utilizing our powerful REST API capabilities.
As of now, only REST based API are supported and there is no GraphQL support.
Get your API keys
- Begin by signing up with the platform. Get in touch at letstalk@bettercommerce.io to initiate the process.
- Once your sign-up is approved and you have your BetterCommerce account, you can login to PIM.
- Proceed to the Settings menu, located at the bottom left corner of the screen. From the settings screen, click on API Keys, and then copy the API key and shared Secret.
- Additionally, you'll require the OrgId and DomainId, which will be provided by your BetterCommerce Account manager at the time of sign-up.
Before you can make requests to the BetterCommerce API, you will need to grab your API key from your account. You find it under Settings » API Token.
Define your Architecture
Most critical part of building any integration is the Solution Architecture, so we cant stress enough to put in decent time to brainstorm and build a solid architecture. Some typical questions to be defined as part of architecture would be:
- Where would the PIM sit in your whole stack ?
- What data to flow from external systems to PIM, their format (json/csv), and the frequency (hourly/daily/weekly) ?
- What data to flow from PIM to external systems, their content, format and frequency ?
- Different use cases will drive different decisions and trade-offs ?
Should you need any assistance or guidance in defining your architecture or need an independent outside perspective, Our solution architects would be more than happy to jump on a call and offer no-obligation free of cost assistance with the same.
A typical architecture would look something like this. This is not a prescriptive, however built based on experience with few large retailers.