APIs

Intro to Enate APIs

Enate has an open REST API that allows other systems to start, track and interact with work in Enate. Enate APIs communicate via HTTPS Get/Post calls using the JSON data format.

Enate also supports Webhooks, which you can subscribe to so your system is updated on Enate activity in real-time. Check out the Webhooks section for more information:

Webhooks

Using Application Credentials to access Enate

Enate allows you to create Application Credentials to support multiple concurrent integrations into Enate via APIs. This approach has replaced the need to use standard Enate user accounts for authorised access to the system, which only supported one concurrent access. The Application Credentials records created in User Management section of Builder can be used to generate 'Bearer Tokens' which can be appended in the header of each API to grant access to Enate. Different permission levels can be granted to each Application Credential by selecting from a number of available 'Roles' when creating the Application Credential.

For more information on this, check out the Application Credentials page in the Builder section:

Application Credentials

Swagger - Enate's Interactive API Documentation

If you've got access to an existing Enate environment, you'll be able to access interactive API documentation for Enate’s APIs using your Swagger link, which will be a unique url specific to your instance available at https://YourPlatformName/YourInstance/WebAPI.

If you don't yet have access to an existing Enate environment to run & test your APIs, you can at least take a 'read-only' look at all of the APIs available and their details in this sample Enate environment link:

https://sample.enate.net/documentation/webapi

More general information on Swagger can be found here.

Sample Integration Patterns Using Enate's API's

Create a Webform that turns requests into Tickets with Enate's APIs