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

We've made changes to how API users and the issuing of API tokens are managed. Wholesalers will now be able to generate API tokens that can be shared with their integration partners. This is managed via the API Admin dashboard, which provides an overview of any tokens created and the total number of calls available to the wholesaler and their pool of integration partners.


API users, please be aware:

  • All tokens that are generated by an Erudus API user utilise the same call pool, which means a wholesaler will have the ability to see the total number of calls being used on an individual per token basis.

  • When generating an API token, 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 recommend that you don't issue write access unless you want the partner to be able to modify your wholesaler product codes. As this will impact what products you are linked with in Erudus.

  • Each API enabled Wholesaler account will need a dedicated API admin to manage the issuing and management of API tokens. The API Admin needs to be set up by the Erudus Support team. Who can be contacted on 03331218999 or via email at support@erudus.com

  • Managing product updates becomes 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.

  • We recommend naming your API Tokens accurately depending on the API partner/solution you're working with. Naming each token appropriately will allow you great clarity when reviewing each partner's usage, as well as ensuring that if you do need to revoke a partner's access, the correct partner is revoked.
Ensuring tokens are named correctly is a fundamental step towards secure, organised, and manageable API integrations, saving you significant time and mitigating critical risks in the long run.

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 03331218999 or via email at support@erudus.com

Related Articles