Overview
The Contract Eagle API allows you to automate the adding, updating, deleting and downloading of most of the data you can see within your Contract Eagle database.
As a customer of Contract Eagle you are entitled to use the API if you are on any of the current cloud plans - Guardian Cloud, Elite Cloud, Ultimate Cloud - or on the legacy plans Professional Cloud or Enterprise Cloud.
Developer Quick Start
The API is available in two different options:
REST API - The simplest.
GraphQL API - Most flexible, efficient and advanced.
Recommended Starting Point
Read the "Getting Started" Guide here:
Our developer resources, included an overview of the REST and GraphQL APIs, Swagger and samples, are available here:
Setup user access from the Admin > Maintain Users option and then generate the API key / secret from the Actions > API Keys option for the user.
REST vs GraphQL
For most customers that choose to integrate directly with Contract Eagle, the REST API will be the simplest and most familiar method.
However, the GraphQL API provides rich, configurable data sets that can be customized to your needs. There are also some features and data available via the GraphQL API that are not available via REST.
Both APIs are available for customer use and a combination of both can be used.
Access Control / Security
API access is granted through the Maintain Users function - this will need to be done by a system administrator. You can choose to grant API Access to existing users or to set up new users specifically for API access.
Note:
If your Contract Eagle licence is limited to a specific number of users, you will need to allocate a user licence to any API user.
Business Unit / Security Group access assigned to your API user within the Contract Eagle application is applied to all actions carried out via the API.
New security groups have been created to assist implementation:
API Read-Only Access
API Read-Write Access
However, use of these groups is optional – you can customize the access assigned to these groups or use existing security groups to control API access.
To assist with monitoring and controlling access we recommend:
Creating a separate user or users for API access.
Minimize the number of users with API access.
Grant API users the minimum set of permissions required
Ask Us...
We would love to hear about how you are wanting to use our API so that we can extend and improve our API for your business.
Please chat with us or email us at support@contracteagle.com with any queries.