Introduction/Prerequisites

Introduction

This is a reference document for EASE REST API

This REST API is for developers who want to integrate EASE with other applications

Some of the things you'll be able to do are:

• Retrieve list of findings
• Update finding information (status, comments, etc..)
• Retrieve list of audits
• Retrieve list of users

Support

For questions or feedback, please email support@ease.io

We'll be looking at adding more functionality, so your feedback is greatly appreciated!

Prerequisites

1. Credentials to EASE platform with admin-level access
2. Public API feature enabled for your organization
3. An understanding of RESTful APIs and using JWT access tokens
4. A high-level understanding of EASE roles and scopes

Getting Started

1. Login to the standard EASE application using your EASE credentials
2. In the Organization > Users section, create a new user profile
3. Select "Create API User"
4. Select the site, scope, and roles for your API user. The recommended roles are:
   1. Site Admin - To view list of sites, users, and programs
   2. Findings Admin - To update any findings that are within scope
   3. Data Analyst - To view list of findings and audits that are within scope

5. Keep a copy of your Client ID and Client Secret
6. Note: Client Secret cannot be recovered, but can be regenerated

7. Click Create to complete creation of your API user

Next Steps

Review API Tutorials section to see some sample code