The Openprise platform orchestrates data in a frequency-based batch fashion through the configuration of Jobs and Bots in the platform. However, users often have data orchestration needs that require real-time processing. The API Factory feature addresses this real-time processing requirement by making Jobs and/or Bots into REST APIs that can be called for immediate response.
Once API Factory is enabled, users can send http POST requests with a JSON array representing multiple records to process into the Openprise API Job or API Bot for real-time processing. The result will be returned in JSON array format with attributes and values resulting from the processing.
Please note that it is important to inform your Openprise Customer Success Manager of your intent to use API Factory such that they can guide and help you. This is a licensed feature of the Openprise platform. Please check with your Openprise Sales or Customer Success Manager if you would like to license API Factory.
API Factory may not be enabled in all users’ tenant. If you require this functionality, please inform your Openprise System Administrator to have this feature enabled. To enable, go to the “Administration” → “Settings” page under the “Features” tab.
Administration → Settings
Once enabled, each user in the tenant who wants to utilize API Factory needs to create an API Key by clicking on the user’s username then go to the “My Account” page under the “API Key” tab to generate an API Key.
Username → My Account
Picking API Jobs or API Bots
Users who have real-time processing requirements that are simple, where all processing can be contained within 1 job, should choose API Jobs.
Any complicated requirements that may require 2 or more API Jobs for processing, should use API Bots to orchestrate the 2 or more API Jobs. Note that API Bots can include processing such as import data sources. API Bots may process much slowly, due to imports, and the potential orchestration of many API Jobs. Users have to keep this in mind when designing the API Bots and understanding the characteristics of the configured API Bot.
Enabling and using API Jobs
Once the API Factory feature has been enabled, any Job in the Openprise platform can be easily converted to a REST API with the “Enable API” action.
An API Factory enabled Job will now have an action of “View API Docs” which provides a quick view of what the http POST’s body should look like as well as what the response should look like.
The “View API Docs” action will show a pop-up that includes the endpoint URL
All jobs that are involved in the API Bot have to be API-enabled jobs.
Not all tasks are available for use with API Factory. As of 2/2020, the following task templates are NOT supported:
- Marketo manage list members
- Marketo merge leads
- RDS MySQL export rule
- Redshift export rule
- SFDC merge records
- Upload file
- De-duplication and merge against master data
- MySQL export task
- PostgreSQL export task
- RDS PostgreSQL export task
- Rackspace MySQL export task
- Microsoft Dynamics merge entity
If you would like to know more about Openprise's API Factory, please consult with your Customer Success Manager.