Help Center/ ROMA Connect/ API Reference/ Example Applications/ Open Service System Data/ Overview
Updated on 2022-12-05 GMT+08:00
View PDF
Share

Overview

Introduction

API Connect (APIC) is a component of ROMA Connect for API integration. APIC can encapsulate existing backend services, data sources, and user-defined functions into standard RESTful APIs and expose them to external systems. This simplifies data sharing or service provisioning and reduces the cost of interconnection between enterprises.

ROMA Connect APIC allows you to quickly expose the service system data of an organization in RESTful APIs for other in-house systems or third-party systems to use.

Implementation

ROMA Connect supports service configuration using the console or APIs. This section describes how to configure open data by calling ROMA Connect service APIs, providing guidance for developers to integrate ROMA Connect functions during service system development.

The following steps show how to call service APIs to expose service system data.

  1. Obtain the integration application ID.
    • If there are available integration applications, call the API for querying the applications to obtain the ID.
    • If no integration application is available, call the API for creating an application and obtain the ID.
  2. Connect to a data source.

    Call the API for creating a data source to connect to the database whose data is to be opened and obtain the returned data source ID.

  3. Create a data backend.
    1. Call the API for creating a backend API to create a custom backend and obtain the returned backend API ID.
    2. Call the API for creating a backend API script to configure the data backend.
  4. Obtain the API group ID.
    • If an API group is available, call the API for querying the API groups to obtain the group ID.
    • If no API group is available, call the API for creating an API group and obtain the group ID.
  5. Deploy and publish a data API.
    1. Call the API for deploying a backend API and publish a data API. Then obtain the returned frontend data API ID.
    2. (Optional) Call the API for modifying an API if you want to add request parameters for the data API.
  6. Bind an independent domain name to the data API.
    1. Call the API for binding a domain name for the data API and obtain the returned domain name ID.
    2. (Optional) If HTTPS is used for the data API, call the API for adding a certificate to the domain name to add an SSL certificate to the independent domain name.
  7. Obtain data API calling information.

    Call the API for querying API details to view and record the API calling information, including the API request protocol, method, path, domain name, parameters, and authentication mode.

    Provide the API calling information for other users to retrieve open service data by calling the data API.

Parent topic: Open Service System Data