integration-systems.md

Integration Systems

Integration System is any system that works in the context of multiple tenants, managing multiple Applications or Runtimes. It exists in a global scope without a tenant assignment. Thanks to introducing Integration System, Applications can be completely unaware of Compass, where all integration between Application and Compass is managed by the Integration System.

GraphQL API Changes

GraphQL API is extended with mutations for managing Integration System, as well as managing its Client Credentials.

type IntegrationSystem {
    id: ID!
    name: String!
    desciption: String
    auths: [SystemAuth!]!
}

input IntegrationSystemInput {
    name: String!
    description: String
}

type IntegrationSystemPage implements Pageable {
	data: [IntegrationSystem!]!
	pageInfo: PageInfo!
	totalCount: Int!
}

type Mutation {
    registerIntegrationSystem(in: IntegrationSystemInput!): IntegrationSystem!
    updateIntegrationSystem(id: ID!, in: IntegrationSystemInput!): IntegrationSystem!
    unregisterIntegrationSystem(id: ID!): IntegrationSystem! 
    
    requestClientCredentialsForIntegrationSystem(id: ID!): SystemAuth!
    deleteSystemAuthForIntegrationSystem(id: ID!): SystemAuth!
}

type Query {
    integrationSystems(first: Int = 100, after: PageCursor): IntegrationSystemPage!
    integrationSystem(id: ID!): IntegrationSystem
}

Workflows

The diagram below represents registering IntegrationSystem and pairing it with Director.

1. An Integration System Administrator executes mutation registerIntegrationSystem with the following input:

registerIntegrationSystem(in:{name: "integration-system"})

2. After creating IntegrationSystem, Administrator enables communication between IntegrationSystem and Director by creating Client Credentials: requestClientCredentialsForIntegrationSystem(id: ID!). Director creates pair Client ID and Client Secret by requesting internal API of Hydra Admin and returns those pair to the Administrator.

3. The administrator manually configures Integration System to use previously generated Client ID and Client Secret for communication with Compass. From that point, Integration System then can fetch access token and start communication with Compass.