Universal connectors

If an extended integration is not available for a vendor application, you can create one.

Note
The focus is on creating universal connectors for assets and users. You can also create universal connectors for custom and system objects.. 

Before you start

To successfully create an integration using Oomnitza's universal connector, you must ensure that the vendor application's API, the target API, meets the following requirements:

• The target API is a RESTful, JSON-based API.

The target API supports one of the following authentication methods:

• Basic Authentication

• API Token Authentication

• OAuth2 Authentication

• AWS Authentication 

The target API must be capable of supporting one of the following pagination methods:

• Limit/Offset

• Limit/Page

• Cursor

• Advanced

• No Pagination

Note
While the API requirements for target APIs are intended to help you successfully complete the integration, every API is unique. Some APIs might appear to meet the requirements, but still contain quirks, limitations, or non-standard behaviors that prevent seamless integration.  

Get a head start

Read the API documentation provided by the vendor application.

Know which Web service URL you need to get the information that you need to map to Oomnitza. 

Find out the type of authentication that is required and retrieve the credentials, such as username, password, API token, and so on, from the vendor application. Create the credentials account in Oomnitza before you add the integration. 

Integrations

The process for creating universal connectors is:

• Add the integration. The main part of which is adding the Web Service URL request which is the API URL that returns information to Oomnitza.   
• Add credentials. You add credentials to Oomnitza to access the external API.
• Schedule. You configure the schedule. By default, the schedule is set to once daily.
• Map fields. You map the external API fields to Oomnitza and select a sync field.
• Launch. You launch the integration. You can run the schedule to test it.

 

Next: Adding integrations