Interface Description

Before releasing a SaaS product to KooGallery, develop a production interface on your server by referring to this access guide.

The following table lists the SaaS 2.0 interface specifications.

When releasing a product, develop interfaces based on the delivery method and billing mode as listed in the preceding table.

If a product can be upgraded, implement the interface for instance upgrade.

Example: https://www.isvwebsite.com/saasproduce

If the dialing test of an interface fails for five consecutive days, the KooGallery operations manager freezes the product transaction and hides the product from customers. According to the Huawei Cloud KooGallery Partner Product Seller Agreement, if the fault is not rectified in time, KooGallery has the right to remove the product from the catalog.

• Instance creation: A customer purchases and pays for a product.
  1. KooGallery calls the instance creation interface to ask you to create an instance based on the order ID.
  2. After receiving the request, your system calls the KooGallery API for querying an order to obtain the subscription information and subscribe to the instance.
  3. KooGallery calls the instance query interface to obtain instance information.
• Instance query: A customer queries information about an instance (instanceId).
  1. After obtaining the instance ID (instanceId) returned by the instance creation interface, KooGallery continuously calls the instance query interface until you successfully return the instance information.
  2. When a customer queries resource information in KooGallery, KooGallery synchronously calls the instance query interface and returns the information.
• Instance update: A customer changes trial use to commercial use, renews resources, or cancels renewals.

  KooGallery calls the instance update interface to notify your system of the resource expiration time. Your system performs the corresponding action and returns the execution result to KooGallery.

• Instance status update: If an instance of a customer expires or the customer violates regulations, the instance will be frozen. After the instance is renewed or the violation is canceled, the instance will be unfrozen.

  KooGallery calls the instance status update interface to ask your system to freeze or unfreeze the corresponding resource and return the execution result to KooGallery.

  

  When a purchased product expires, the retention period starts. The retention period varies with the customer tier and can be up to 15 days long. During the retention period, the product is frozen and cannot be used. The customer can continue using the product after renewal. Therefore, you need to set a retention period to no less than 15 days for your SaaS products and retain customer data during the retention period.

• Instance release: A customer releases an instance of a purchased product (in scenarios such as no renewal upon expiration and unsubscription).
  1. KooGallery calls the instance release interface to ask your system to release the corresponding resource and return the execution result to KooGallery.
• Instance upgrade: A customer upgrades purchased resources and pays for the upgrade order.
  1. KooGallery calls the instance upgrade interface to ask your system to upgrade the corresponding resource.
  2. Your system calls the KooGallery API for querying an order to obtain the upgrade information, upgrades the instance, and returns the execution result to KooGallery.

  For details about the instance upgrade process, see Upgrade and Billing Rules.

• Tenant synchronization
  1. After a customer purchases a joint operations SaaS, logs in to Huawei Cloud console, and binds the app with their enterprise, KooGallery calls this interface to ask you to synchronize the tenant information of the enterprise, save the tenant information, and return the result to KooGallery.
  2. If the interface fails to be called, the customer can retry calling. You will be notified of the calling failure via SMS message or email.
  3. When processing an interface request, your server must ensure idempotency.

     For the same instance under a tenant, your server must support multiple requests for adding or deleting the instance. For subsequent additions, no new data should be generated and a success message must be returned. For deletions, you do not need to verify whether the instance generated after the instance creation interface is called exists, but you should return a success message after each deletion.

• App synchronization
  1. After a customer purchases a joint operations SaaS, logs in to Huawei Cloud console, and binds the app with their enterprise, KooGallery calls this interface to ask you to synchronize the authentication information of the app, save the app information, and return the result to KooGallery.
  2. If the interface fails to be called, the customer can retry calling. You will be notified of the calling failure via SMS message or email.
  3. When processing an interface request, your server must ensure idempotency.

     For the same instance of the same app under a tenant, your server must support multiple requests for adding or deleting the instance. For subsequent additions, no new data should be generated and a success message must be returned. For deletions, you do not need to verify whether the instance generated after the instance creation interface is called exists, but you should return a success message after each deletion.

• App authorization
  1. After an administrator is authorized to manage an enterprise, logs in to Huawei Cloud console, and authorizes users in the enterprise to use apps bound to the enterprise, KooGallery asynchronously calls this interface to ask you to synchronize the user authorization information of the apps, save the information, and return the result to KooGallery.
  2. If the interface fails to be called, the administrator can retry synchronization. You will be notified of the calling failure via SMS message or email.
  3. When processing an interface request, your server must ensure idempotency.

     For the same instance of the same app and userName under a tenant, your server must support multiple requests for adding or deleting the instance. For subsequent additions, no new data should be generated and a success message must be returned. For deletions, you do not need to verify whether the instance generated after the instance creation interface is called exists, but you should return a success message after each deletion.

• Organization synchronization (incremental)
  1. After an administrator is authorized to manage an enterprise, logs in to Huawei Cloud console, and creates, edits, or deletes departments for the enterprise, KooGallery calls this interface to ask you to synchronize organization changes, save the organization information, and return the result to KooGallery.
  2. When processing an interface request, your server must ensure idempotency.

     For the same instance of the same orgCode under a tenant, your server must support multiple requests for adding or deleting the instance. For subsequent additions, no new data should be generated and a success message must be returned. For deletion, you do not need to verify whether the instance generated after the instance creation interface is called exists, but you should return a success message after each deletion.

• Organization synchronization (full)
  1. After a customer purchases a joint operations SaaS, logs in to Huawei Cloud console, and binds the app with their enterprise, KooGallery calls this interface to ask you to synchronize all organization information of the enterprise, save the organization information, and return the result to KooGallery.
  2. When processing an interface request, your server must ensure idempotency.

     For the same instance of the same orgCode under a tenant, your server must support multiple requests. No new data should be generated and a success message must be returned.