VersaFeed already integrates with many common APIs from PIM, ERP, eCommerce, and other enterprise-class product databases. However, VersaFeed developers are happy to write custom code to integrate with your company's custom API as well. Here are a few things to note:
- VersaFeed only requires access to product catalog data (skus, titles, descriptions, image links, brand, etc.) A more detailed list can be found here under "Required Fields".
- If VersaFeed will create your Local (LIA) or Regional (RAAP) feeds, the API must also provide store and warehouse-level prices and quantities.
- VersaFeed does not need access to customer, transaction (cart/checkout), analytics, or PII data.
- VersaFeed prefers read-only access to APIs when possible.
- The API must be well-documented and tested. Generally, VersaFeed will not integrate with beta APIs or provide extensive debugging if the API is not functioning correctly.
- APIs generally must be performant enough to allow VersaFeed to refresh or update a client’s full database at least once every 24 hours.
- Additional fees may apply. API integration is more complex than flat file (e.g., CSV/TSV) SFTP data transfers.
To assess the viability of integrating your product catalog API, VersaFeed developers will need the following information. Please provide it to your VersaFeed sales engineer or direct rep:
- A link to your API documentation.
- Details on your API authentication scheme (e.g., OAuth, shared secret key with hashing, etc.).
- Sample code in any modern language, especially if the API access methods are multi-step, async, or non-obvious.
- Details on any methods to facilitate request batching for bulk API requests.
- Rate limiting info. Keep in mind, VersaFeed will attempt to refresh your full product catalog every 24 hours, so the rate limits should support that level of access.
- Information about any major changes coming to your API within the next 12 months (e.g., major version releases, deprecations).
Once this information is provided, VersaFeed developers will typically need about two weeks to assess the API for costs and overall viability.
VersaFeed has been working with custom APIs to extract product details since 2007, and we look forward to helping serve your business.