Using Our APIs

Test & Production Sites

• You should develop the API connection using your Test site. Developing against the Test site will help avoid runaway processes that could impact the performance of your Production application.
• No test environment? No problem! Utilize the Developer Hub to review header and query parameters. For further testing, remove '-test' from the webservices URL and proceed using your internal API tool.
• API Access URLs:
  Test: https://webservices-test.net-chef.com
  Production: https://webservices.net-chef.com/
• There is validation to prevent accidental updates to production databases when interacting with testing endpoints. If an API request is sent to a testing endpoint (e.g., containing “-test” in the URL), the system will verify that the associated site name also includes “-test.” If there’s a mismatch, the request will be blocked, and an error will be returned.

  Important Note: This validation may impact scenarios where a site name is used for testing but does not include “-test” in the endpoint URL.

### Updating Records

• Some records reference existing entries within the application (such an Employee record referencing Locations and Positions). When updating these records, the referential data you enter must match the existing entries in the application exactly. The API will not create new records for the reference data. (i.e. you must create Locations and Positions before you create Employees, and reference the Location and Position exactly in the updated Employee record.)

/getAll vs. /getByPage

• We have a protocol for our APIs to ensure optimal performance and prevent system abuse. Our 'getall' endpoint, designed for targeted queries, includes required parameters to efficiently manage data requests and safeguard against misuse. Conversely, our 'bypage' endpoint is tailored for larger data retrievals, promoting scalability and streamlined access to extensive datasets. Notably, unlike the 'getAll' endpoint, the 'getPage' endpoint doesn't necessitate required query parameters for accessing detailed information, enhancing user convenience and simplifying integration processes.