Integrate to interworks.cloud


The interworks.cloud integration framework is designed to enable data synchronization (accounts, products, invoices etc.) with third-party systems. It can be used for integrating with any ERP, Finance, CRM or ticketing system that supports RESTful API. It requires no development effort since all data synchronization scenarios are defined with the use of a JSON document that follows the OpenAPI-Specification (v3) Standard.This JSON document will be used to describe the third system RESTful API (authentication, API paths, and objects) and the transformation schemas between interworks.cloud and third party system data objects. 

Overview

The interworks.cloud integration framework is designed to enable data synchronization (accounts, products, invoices etc.) with third party systems. It can be used for integrating with any ERP, Finance, CRM or ticketing system that supports RESTful API.

Register a New Integration Connector

A new integration connector with a third party system can be defined in setup area:

Describe Third Party System's API

After registering a new connector, sample JSON Specification will be pre-filled. In this page we'll explain how the authentication, the API paths and the object schemas of the third party system API must be defined.

Define the Data Transformation Schemas

The Synchronization tab should be used in order to convert a JSON object from the  third party system to inteworks.cloud JSON object and vice versa. Each object must contain a brief description, the module type that will be synced and the push or pull action. Push is for sending data to the third party system and Pull for receiving data.

Create an Integration Instance

After setting all the required information (Authentication, API paths and Objects), you can now create an instance to your staging or production deployment of your third party system. You can have your BSS linked with more than deployments of the same third party system.

Bearer Token Authentication Scheme Setup

Bearer authentication type is fully supported in the integration framework. On this page, you can find the guide on setting up the JSON schema of any connector to utilize the OpenAPI 3.0 Swagger’s Bearer authentication token.

interworks.cloud JSON Objects

Below is a list of the available BSS JSON objects.

Libraries & Examples

This page include references to libraries used by the integration framework and examples 

Log Mechanism

The logging of the integration framework actions is managed from our generic logging mechanism. You must define first the level of logging you wish to have for the integrations you have activated using our integration framework and then you can access these logs from our audit log.

Testing the Integration Instance

In this article, we will explain how you will be able to try the Push and Pull methods between BSS and external integration systems through the custom integration connector.
As an example, we will use a Microsoft Dynamics Navision integrator to describe the procedure. 

Testing Process of the Custom Integrator

Integration Instance Scheduler

For each out-of-the-box connector that you activate or for any custom integration you will build, you must define a data exchange schedule. This can be accomplished from the "Scheduled Jobs" setup option.