Updated on 2025-01-10 GMT+08:00

Process Flow

Enterprises or developers selectively expose and monetize their services and data through APIG.

  1. Creating an API Group

    Each API belongs to an API group. Create an API group before creating an API.

  2. Adding an SSL Certificate for an API

    If the API group contains HTTPS APIs, add an SSL certificate to the independent domain name.

  3. Configuring the Domain Name for Calling APIs

    Before exposing an API, bind an independent domain name to the target group so that API callers can access the API.

    You can debug the API using the debugging domain name allocated to the group to which the API belongs. The domain name can be accessed a maximum of 1000 times every day. It is for debugging only, not for production.

  4. (Optional) Creating a Load Balance Channel

    To access a backend service deployed on a specified server, you can create a load balance channel.

  5. Creating an API

    Encapsulate existing backend services into standard RESTful or gRPC APIs and expose them to external systems.

    After APIs are created, perform operations in Configuring API Policies and Managing APIs based on service requirements.

  6. Debugging an API

    Verify that the API service functions are normal using the online debugging provided by APIG.

  7. (Optional) Configuring the Environment and Environment Variables

    An API can be called in different environments, such as production, testing, and development environments. The RELEASE environment is the default environment. If you use the RELEASE environment, skip this step.

    If environment variables are defined in backend information of an API, you need to add the variables to the environment. You can create variables in different environments to call different backend services using the same API.

  8. Publishing an API

    The API can be called only after it has been published in an environment.