Operational API vs. Integration Platform API

Doohickey is built to be run in conjunction with a sufficient integration platform. While not exclusively so, Doohickey is most compatible with Open Integration Hub, an open source integration framework. This article describes how the Doohickey Cloud Services API combines with the APIs and capabilities of the integration platform to provide a fully functional embedded integration solution for software product teams.

Which API Does What

The responsibilities for providing embedded integrations are shared between the operational API provided by Doohickey Cloud Services and the integration platform's API (and underlying capabilities). You software application should interact with both APIs, typically in the following ways:

Operational API

  • Loading integrations and their templates
  • Triggering Oauth flows (though end user credentials are not stored in Doohickey Cloud)
  • Viewing data integration activity
  • Deploying end user instances of integrations, using the end user-provided configuration options
  • Activate and Deactivate Integrations

Integration Platform API

  • Store end user credentials
  • Inspect underlying log data
  • Provision integration platform tenants/accounts

Using Both APIs Properly

When embedding integrations into your applications or software products, you must interface with both APIs. Whenever possible, expect to integrate with Doohickey Cloud's APIs over the integration platform's. In the event of duplicate functonality, Doohickey includes additional functionality.

You may also store GUID cross-references between the systems, e.g. storing an Open Integration Hub Secret Service record ID in an Integration Config object. Only refer to entities across systems by their GUID. Do not embed or store sensitive information in the system that isn't intended to store it.