Getting Started

API Token

To access any of the Crunchtime Inventory & Labor or Cruise APIs, you need to possess an appropriate access token. There are separate tokens for each API Service as well as for Test and Production environments. The list of Services can be found on the Documentation > Inventory & Labor Page. Please contact Crunchtime Support to request API tokens and indicate in your request (1) which services you are interested in and (2) whether it is for your Test or Production environment.

🚧

Need an API Authentication token?

If you do not have a token, please contact Crunchtime Support

An example email request is as follows:

Hi Support,
Please provide the following API Tokens:

1. Test Application User Service
2. Production Application User Service
3. Test Company Product Enhanced Service
4. Production Company Product Enhanced Service

API Key Fields

This section lists the required fields:

• authenticationtoken: Enter the Test or Production token needed to connect to the correct Crunchtime environment.
• sitename : Enter the Site Name that corresponds to the Crunchtime site you are using. The site name is the portion of your URL that comes before .net-chef.com
  • For example, if your URLs for TEST = eattacos-test.net-chef.com and for PRODUCTION =eattacos.net-chef.com , then the site name for test should be eattacos-test and eattacos for production.
  • The url should not include the "-em".
• userid : Enter the User ID for the Crunchtime Application User.
• password : Enter the Password for the Crunchtime Application User.

📘

Setup Note: Application User ID

The Application User ID and Password are created by your Crunchtime Administrator. It is recommended to create a dedicated Application User account (e.g., "API User") rather than using an actual named user account. This Application User must be active and, where appropriate for certain "save" operations, should be linked to specific user group controls as defined by the Standard Interface Guide. No additional user permissions are required for the "get" operations.

Making your first request

After getting the API token, site name, and userid credentials, go to the API Reference page and click Try it! to confirm the ability to communicate with the API for both GET and POST calls.

👍

You should be all setup to make API calls!

If you encounter any problems, please contact Crunchtime Support Otherwise, continue with the documentation on the left.