Compliance Ecosystem APIs

This section will define the APIs used by the digital compliance ecosystem. In total four custom APIs will be developed:

  1. Compliance Document Service API
  2. Result Service API
  3. Rule Engine API
  4. Rule Engine Interface API

Additionally, four pre-existing APIs will be utilised based on our re-use of existing software components:

  1. OAUTH2 - API here
  2. OpenIDConnect - API here
  3. Netflix Eureka Service Discovery API - API here

The APIs relationships to the ecosystem components are shown below.

APIS

This remainder of this page specifies the CUSTOM APIs for the Digital Compliance Ecosystem. For specific endpoint information related to the pilot deployment please see here

Compliance Document Server

  1. API Specification

Results Service

  1. API Specification

Rule Engine

  1. The Rule Engine API Specification
  2. The Rule Engine Interface - which should be implemented by all services that the rule engine can connect to - API Specification