Getting Started with APIs

API Tokens

To access any of the Crunchtime Inventory & Labor or Cruise APIs, you need to possess an appropriate access token. There must be separate tokens generated for your Test and Production environments.

Current Process - There are separate tokens for each API Service as well as for Test and Production environments. 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. See steps below for details.

Beta Process - With an API Token, an Application User will have access to data for all locations associated to that user's Crunchtime URL/site name. Within each of those environments (Test/Prod), a single token can now be used to access multiple API services. See steps below for details on how to create API tokens.

The list of Services can be found on the Documentation > Inventory & Labor Page.

🚧
Need an API Authentication token?
Current Process
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:

Test Application User Service

Production Application User Service

Test Company Product Enhanced Service

Production Company Product Enhanced Service

Beta Process
If you do not have an API token, we have a new process for managing them, built right into Enterprise Manager, so your system administrators can now perform this task themselves.
Follow the steps below to enable a system administrator to manage your tokens:

In Enterprise Manager, under the Security menu, select User Groups.

Edit the User Group for the desired system administrator.

Enable the “Application Users > API Tokens” control.

The above user can follow the steps below to Add, Edit, Regenerate, or Revoke API tokens for a specific user:

In Enterprise Manager, under the Security menu, select Application Users.

Edit the user record for the Application User that needs API access granted or modified.

In the detail screen, select the API Tokens tab.

Use this tab to manage the tokens for one or more APIs for that user.

For more details on this process, take the Manage Your API Tokens Feature Tour

If you have more questions about API Tokens, see our API FAQs

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.