Mobile Platform as a Service:Register an API

Mobile Gateway Service supports five API types. Register an API in the console to let mobile clients call your backend services through the gateway.

The registration steps differ by API type. Jump to the section for your type:

• HTTP API

• MPC API

• Dubbo API

• TR API

• HRPC API

Prerequisites

Before you begin, ensure that you have:

• An MPC API group (required before registering an MPC API)

• A Dubbo or TR API group (required before registering a Dubbo or TR API)

  Add an HTTP API

  1. Log on to the mPaaS console. In the left navigation pane, click Mobile Gateway Service.

  2. Choose Background connection > Mobile Gateway Service.

  3. On the API Management tab, click Create API.

  4. In the dialog box, select the HTTP API type.

  5. In the operationType field, enter a value and click OK.

     • The operationType is the unique identifier for the API service within the current environment and app.

     • The operationType must follow this format: Organization.ProductDomain.Product.Subproduct.Operation.

  Add an MPC API

  Mobile Gateway Service automatically pulls the MPC APIs from the selected group.

  1. Log on to the mPaaS console. In the left navigation pane, click Mobile Gateway Service.

  2. On the API Management tab, click Create API.

  3. In the dialog box, select the MPC API type.

  4. Select an API group, then select the service to register from the list of retrieved APIs.

  5. Click OK.

  Add a Dubbo API

  1. Log on to the mPaaS console. In the left navigation pane, choose Background connection > Mobile Gateway Service.

  2. On the API Management tab, click Create API.

  3. In the dialog box, select the Dubbo API type.

  4. Select an API group, then select the service to register from the list of retrieved APIs.

  5. Click OK.

  Add a TR API

  Mobile Gateway Service automatically pulls the TR APIs from the selected group.

  1. Log on to the mPaaS console. In the left navigation pane, choose Background connection > Mobile Gateway Service.

  2. On the API Management tab, click Create API.

  3. In the dialog box, select the TR API type.

  4. Select an API group, then select the service to register from the list of retrieved APIs.

  5. Click OK.

  Add an HRPC API

  Mobile Gateway Service automatically pulls the HRPC APIs from the selected group.

  1. Log on to the mPaaS console. In the left navigation pane, choose Background connection > Mobile Gateway Service.

  2. On the API Management tab, click Create API.

  3. In the dialog box, select the HRPC API type.

  4. Select an API group, then select the service to register from the list of retrieved APIs.

  5. Click OK.

What's next

After registering an API, publish it to an environment so mobile clients can call it. You can also configure security policies and debug the API before release.