The Equus Platform supports integrating with other systems by leveraging a new industry standard API. The API accepts requests and sends responses in JSON and leverages JWT (JSON Web Tokens) to authenticate calls made to it. For a JWT to be properly built, a GUID and Secret Key will need to be generated for an API Subscriber.
Below is a high level overview of the steps needed to configure a Client's webserver to use the API, as well as the actions that need to be taken in the Equus Platform.
Step 1: Configure client sites to use the API - please contact your Equus representative. Configuration is done by the Equus Development Team.
In the Equus Platform:
Step 3: Create API Subscriber and generate authentication credentials for API Subscriber. Subscribers can subscribe to the following APIs:
Data
Documents
Note that steps 1 & 2 will only need to be done once per client site when a client wants to use any of the standard Equus Platform APIs capabilities. Equus will be shipping additional API capabilities in forthcoming releases, which can be configured using the enhancements described above.
Things to note
API Subscribers are created via the User Maintenance screen. After an API subscriber is created it is possible to add new subscriptions or remove existing ones.
API Subscribers when logged into the Equus Platform will have access to Swagger (technical documentation and experimentation tool that can be used to explore the Equus Platform API) - this is not available for SCIM API Subscribers.
API Subscribers are assigned the Security Role called "Equus - API" which grants no screen rights to API Subscribers and is automatically applied to the API. If desired, this role can be deleted from the system without impacting the functionality of the API Subscribers; best practice is to have a role configured that grants no access to internal or external screens that can still be associated to the API.
API activity is captured in specific logging tables created for the feature: API_EVENT and API_EVENT_DETAIL.
There are 2 system preferences that are available:
APIDEFPAGE - governs the default number of records that will be returned when a call is made to the API
APIMAXPAGE - governs the maximum number of records that will be returned when a call is made to the API
For 20.2 and beyond, all clients will have an API Subscription record for AIRINC in the Equus Platform. Use of this feature requires an AIRINC subscription.
The API will provide appropriate, descriptive error messages to technical teams integrating with it or to systems that are integrated with it. Detail records of API events older than 15 days will be automatically purged, but high-level information about events will be kept in the database.
You can view the log of each API event in the system using the API Event History Screen. This includes both requests, responses, and errors. For more details, you can read Equus Platform API - Viewing API Event History.
Cost Estimate and What-If Cost Estimate calculations created with API requests will decrement relevant click counters and licensing modules.