interworks.cloud Portal
  • Public API
    • API Explorer
    • Authorization & Authentication
    • Testing the API
    • Pagination Metadata
    • Versioning and Deprecation
    • $filter Parameter
    • $Filter Options
    • $orderby Parameter
    • Updating via Patch Document
    • API Deprecation
    • API Release Notes
  • Integration Framework
    • Overview
    • Register a New Connector
    • Describe Third Party System API
    • Define the Data Transformation Schemas
    • Create an Integration Instance
    • Bearer Authentication Scheme Setup
    • Libraries & Examples
    • Connector Report
    • Testing the Integration
    • Connector Scheduler
    • Platform JSON Objects
  • Service Management
    • Introduction to Service Management
    • Understanding the Provisioning Process
    • Introduction to the interworks.cloud Platform
    • Recurring Services
      • When to Use This Approach
      • Get started in 9 minutes
      • Implementation Roadmap
      • Defining your Product Catalog
    • Implementation Guide
      • Register your Application
      • Application Authentication
      • Get Services Definition (Recurring Services)
      • Get Services Definition (Pay Per Use Services)
      • Customer Management
      • Reseller Provisioning
      • Subscription Management
      • Addon Management
      • Resources Calculation
      • Accessing the Public API
      • Pre-check Mechanism
    • Flow Diagram Library
      • Basket Checkout for Unsynchronized Account
      • Basket Checkout for Synchronized Account
      • Basket Checkout (Reseller Provisioning is Supported)
      • Increase Quantity (Storefront)
      • Subscription Creation
      • Subscription Cancellation (Storefront)
      • Subscription Cancellation (BSS)
      • Order Execution (BSS)
      • Account Synchronization (BSS)
      • Trial Upgrade (Storefront)
      • Trial Upgrade (BSS)
    • Use Cases
      • Apply Min/Max Order Quantity
    • Tools
      • API Explorer
  • Payment Gateways
    • Payment Gateway SDK (v2.0)
    • Payment Gateway – Redirection flow
    • Storefront Emulator
  • Developer Resources
    • GitHub
    • NuGet Packages
  • Public API
    • API Explorer
    • Authorization & Authentication
    • Testing the API
    • Pagination Metadata
    • Versioning and Deprecation
    • $filter Parameter
    • $Filter Options
    • $orderby Parameter
    • Updating via Patch Document
    • API Deprecation
    • API Release Notes
  • Integration Framework
    • Overview
    • Register a New Connector
    • Describe Third Party System API
    • Define the Data Transformation Schemas
    • Create an Integration Instance
    • Bearer Authentication Scheme Setup
    • Libraries & Examples
    • Connector Report
    • Testing the Integration
    • Connector Scheduler
    • Platform JSON Objects
  • Service Management
    • Introduction to Service Management
    • Understanding the Provisioning Process
    • Introduction to the interworks.cloud Platform
    • Recurring Services
      • When to Use This Approach
      • Get started in 9 minutes
      • Implementation Roadmap
      • Defining your Product Catalog
    • Implementation Guide
      • Register your Application
      • Application Authentication
      • Get Services Definition (Recurring Services)
      • Get Services Definition (Pay Per Use Services)
      • Customer Management
      • Reseller Provisioning
      • Subscription Management
      • Addon Management
      • Resources Calculation
      • Accessing the Public API
      • Pre-check Mechanism
    • Flow Diagram Library
      • Basket Checkout for Unsynchronized Account
      • Basket Checkout for Synchronized Account
      • Basket Checkout (Reseller Provisioning is Supported)
      • Increase Quantity (Storefront)
      • Subscription Creation
      • Subscription Cancellation (Storefront)
      • Subscription Cancellation (BSS)
      • Order Execution (BSS)
      • Account Synchronization (BSS)
      • Trial Upgrade (Storefront)
      • Trial Upgrade (BSS)
    • Use Cases
      • Apply Min/Max Order Quantity
    • Tools
      • API Explorer
  • Payment Gateways
    • Payment Gateway SDK (v2.0)
    • Payment Gateway – Redirection flow
    • Storefront Emulator
  • Developer Resources
    • GitHub
    • NuGet Packages
Generic selectors
Exact matches only
Search in title
Search in content
post
faq
Filter by Categories
Public API
Recurring Services (pre-defined plans)
Implementation Guide
Integration Framework
Flow Diagram Library
Service Management
Use Cases
Payment Gateways
Tools
Developer Resources
Uncategorized
  • Support
  • »
  • Integration Framework

Integration Framework

Keep in sync with any third party software.

Overview

This page is an overview of the interworks.cloud integration framework.

Register a New Connector

This page shows how to setup a new connector in the BSS.

Describe Third Party System API

This page shows 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 guide on this page shows how to convert a JSON object from a third party system to an inteworks.cloud JSON object and vice-versa.

Create an Integration Instance

This page contains a guide to creating an instance in the staging or production deployment of your third party system.

Bearer Authentication Scheme Setup

This page is a guide to set up the JSON schema of any connector to use the bearer authentication token of the OpenAPI 3.0 Swagger.

Libraries & Examples

This page includes references to libraries used by the integration framework as well as some examples of their use.

Connector Report

The reporting tool described in this section is used to identify and troubleshoot any unexpected or erroneous behavior of the integration framework.

Testing the Integration

This article describes the Push and Pull methods between the BSS and external integration systems through the custom integration connector.

Connector Scheduler

This page shows how to define a data exchange schedule for each out-of-the-box connectors or custom integrations.

Platform JSON Objects

This is a list of all the available BSS JSON objects.

© 2022 interworks.cloud | Helping you take your business to the cloud | IMPRINT

  • Discover

    • Public API
    • Integration Framework
    • Service Management
    • Payment Gateways
    • Developer Resources
  • Resources

    • Release Notes
    • Platform Documentation
    • Our Integrations
    • Blog
  • Connect

    • Facebook
    • LinkedIn
    • Twitter
    • Contact Us
    • Privacy Policy