Developer's Guide
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 https://interworkscloud.atlassian.net/wiki/spaces/ICPD/pages/4662543/Librar
- 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
- 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.
interworks.cloud Platform API
- Available API Methods — If you are using the hosted edition of our platform, you can find our API documentation in the correspondent hosted location:
- Authorization & Authentication — In order to make calls to interworks.cloud BSS and Billing API you must be authorized and authenticated.
- Testing our API directly from the Documentation — Our API can be tested without writing any code directly from our documentation.
- Pagination / Pagination metadata — Some of the API calls support pagination (page number and page size). In order to get the metadata related to pagination, the REST call should send in the Header section the following value:
- API Versioning and Deprecation Policy — interworks.cloud Platform BSS API is versioned in order to provide maximum backwards-compatibility to external applications and allow for maximum flexibility for future expansion.
- API Deprecations — On the following pages, you can check the API Deprecations of all objects' end-points based on their respective versions.
- Updating via Patch Document — The interworks.cloud Platform API supports partial updates on all entities via the HTTP PATCH methods that accept the JSON Patch (http://jsonpatch.com http://jsonpatch.com/) format for input.
- Ordering Collections ($orderby) — The interworks.cloud Platform API provides ordering options on all basic methods that return a collection of resources using the $orderby parameter. The “Ordering of Collections”, enables sorting of the resources in a collection given certain criteria and priorities.
- Filtering Collections ($filter) — The interworks.cloud Platform API provides filtering options, on all basic methods that return a collection of resources, using the $filter parameter.
- Integration Scenarios — A list of the most common integration scenarios
Service Management API
- How interworks.cloud Manages Cloud Apps — interworks.cloud Platform provides a unified system to automate day-to-day management and enablement of cloud services addressing all critical operational challenges for provisioning, monitoring, metering, self-management, authentication and further integration into other applications in the provider’s systems. Integration of interworks.cloud Platform with any provisioning platform gives Service Providers the ability not only to setup and manage the services offered to their customers but to dev
- Using the API — Service Management API requires development of a RestFul API that will act as integration service and will be called in order to apply several provisioning actions to the external application.There are no requirements or limitations regarding the language, the technology or the hosting environment of the RestFul API, as long as the required methods are functioning properly.
- Getting Started with Service Management API — Integrating your application with interworks.cloud Platform, include the following steps:
- Service Management API Reference — Description of the Service Manager EndPoints
- Pre-Check Mechanism
- Integration Guide
- Refresh the Account Synchronization Options fields — This page explains how you can update the account synchronization options if you have changed them in your service manager implementation.
- Subscriptions and Addons - How to calculate the resources to be provisioned