February 22nd 2022, Release Note: RME: GET API Base URL, v1, Deprecation

Summary

GET API URL, v1, Deprecation

The version 1 base URL of the Recipe and Menu Engineering API GET requests: api.starchef.net/[resource] will be deprecated on 22 February 2022. API users should use the newer version (version 2) api.starchef.net/v2/[resource].

Release date: February 22nd 2022

GET API Base URL, v1, Deprecation

Enabled by Default? - Yes
Set up by customer Admin? - No
Enable via Support ticket? - No
Affects configuration or data? - Yes
Roles Affected: - API users who use v1 of the RME GET API 'base URL'

What's Changing?

On February 22nd 2022, version 1 of the Recipe and Menu Engineering GET API base URL: api.starchef.net/[resource] will stop working. API users should use the newer version (version 2) api.starchef.net/v2/[resource].

Reason for the Change

To improve the health of the RME application and make it easier to maintain.

Customers Affected

All customers using the old base URL for RME GET requests: api.starchef.net/[resource].

Release Note Info/Steps

API users should use the newer URL (version 2) api.starchef.net/v2/[resource] which has been available in production for approximately four years.

Any existing integrations should be tested to ensure they continue to work without error with the version 2 URL and version 2 responses.

All requests that are available using version 1 are available using version 2.

Please note that there are additional properties in some of the version 2 responses. See the document in Additional Resources (below) for details.

New Terms/Acronyms

REST APIs have a base URL to which the endpoint paths are appended. This base URL is what is changing.

Additional Resources

RME (formerly StarChef) API: Differences in Responses | v1 vs v2 – Fourth & HotSchedules Customer Success Portal