All Products
Search
Document Center

API groups

Last Updated: Dec 03, 2021

API group is the group to which the API belongs. It can be a specific system name, module name, or abstract identifier.

Create an API group

Complete the following steps to create an HTTP API group:

  1. Select API group tab to go to the API group list page.

  2. click Create API group, and then fill out the form in the pop-up dialog box.

    • Type: It is HTTP by default.

    • API group: Required, it is the name of the business system which provides services.

    • Host: Required for HTTP service, it is the business system’s HTTP/HTTPS URL.

    • Timeout period: Optional, it is the timeout period (in ms) for sending requests to the business system. It defaults to 3,000 ms.

  3. After you fill out the form, click OK to submit.

Configure the API group

Complete the following steps to configure the API group:

  1. In the API group list, find the HTTP group, and click Details in the Operations column of the API group to go to the API group details page.

  2. On the detail page, click Edit at the upper-right corner to configure the group. The configuration items of HTTP group are as follows:

    • Host: The URL address of HTTP services.

    • Timeout period: In milliseconds, 3,000 ms by default.

    • Verification signature: Enable it if the business system needs to verify the caller’s identity. See instructions on backend signature verification for how to verify. Once you turn the switch on, you must complete the following configuration.

      • Encryption algorithm: The algorithm for generating signature. Public cloud supports MD5 and RSA algorithms, while private cloud supports MD5, RSA, and MOBILEGW.

      • Key: The key used in backend signature, customizable.

      • Key content: The value used in backend signature.

        • When the signing algorithm is MD5, the content is customizable.

        • When the signing algorithm is RSA, the content is the public key of Mobile Gateway Service.

        • When the signing algorithm is SM2 or SM3, the content is customizable.

        For how to generate keys, see Key generation method.