Introduction to API v2
This guide will help provide some clarity on changes to our API, providing further detail on what's changed and how users can gain access to the API following the release of version 2.
What's changed?
In January 2024, Erudus launched a major update to the platform, and with this change, we introduced new attributes and functionality that were previously not available in Erudus. The reason for the update was primarily aimed at enhancing functionality, improving user experience, and adapting to evolving industry needs and regulations.
One of the challenges Erudus and our users have faced since this update was that we updated our data model and portal, however, our API was running on the pre-existing data model. Whilst we made changes to API v1 to ensure that the data was still displaying accurately and that it could still be a reliable source of product infomation, we needed to update our API for users to take full advantage of the enhancements we made.
Some of the new functionality that is now available via the API includes:
- Revision/Version Control - The ability to access a specific version of a product, not just the most current
- Updated Data Model - All of the attributes that have been added or updated from our legacy data model will be presented. Some of these new data sets include:
- Allergen "Free From" claims
- An enhanced waste packaging data model
- Additional nutritional attributes for the product 'as sold' and a prepared product (if applicable)
- Expanded product origin information
- More technical product characteristics
- Wholesaler Catalogs - API users have the ability to call products within a Wholesaler's catalogue.
- Managing Wholesaler Product Codes - API users will be able to add and remove wholesaler product codes from a wholesaler's product catalogue, giving further control and automation over their product range in Erudus.
Things to know going forward
Wholesalers and integration partners will need to contact the Erudus support team in order to be granted an API access token.
- All tokens that are generated utilise the same call pool, which means wholesalers that have multiple API partners accessing their product data need to be aware that all of their partners are contributing towards the call limit.
- API Access is granted in two ways: you grant either read or write access.
- Read access - Read-only access to Erudus product data via API, unable to make any changes.
- Write access - Manufacturing API users are able to publish product data into Erudus via the Erudus API As a wholesaler API user, this access allows API users to add/remove and amend a wholesaler's product catalog.
We would suggest that wholesalers don't grant/request write access unless they want their partner to be able to modify their wholesaler product codes. As this could impact their product range within Erudus.
- The issuing and management of API tokens will continue to be managed by the Erudus Support team. Who can be contacted on 0333 121 8999 or via email at support@erudus.com
- Wholesalers managing product updates become more important than ever. Your product codes will be linked to specific product versions, and the API will pull the version of the product your code is linked to and not just the most recent version in the way the old API did. This can be done in two ways, either manually by managing product updates via the wholesaler dashboard or by using the Erudus Auto Stepping feature.
- Find more infomation regarding the Auto Stepping feature here - https://secure.helpscout.net/docs/5e4d1f4a04286364bc958c6d/article/67654445defe61183037b942/
- Find more infomation on how to manage Product Updates here - https://secure.helpscout.net/docs/5e4d1f4a04286364bc958c6d/article/6596e88d3afe0a1c1e4d068d/
Next steps?
Moving from API v1 to v2 will require some adjustments due to the nature of the changes and the addition of new attributes. As such, you can view more details on migrating from API v1 to API v2 via our developer portal: https://developer.erudus.com/getting-started/migrating-from-api-v1
Find more infomation such as an Introduction to the API v2 developer documentation, change log, authentication, and more, visit - https://developer.erudus.com/
If you have any further questions about the Erudus API, please feel free to reach out to the Erudus support team on 0333 121 8999 or via email at support@erudus.com