Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Interface Functions

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

Before releasing a SaaS product to KooGallery, develop a service interface on the ISV server by referring to this access guide.

NOTE:
  • Only one service interface for a SaaS product needs to be configured to accommodate different scenarios, including subscription, renewal, expiration, release, and upgrade.
  • If you release a yearly/monthly product, the interface will be called in the subscription, renewal, expiration, and release scenarios.
  • If you release a product billed by one-time payment, the interface will be called only in the subscription and release scenarios.
  • If you release a pay-per-use product, the interface will be called in the subscription, resource status change, release, and usage push scenarios.
  • If the product can be upgraded, the interface will be called in the upgrade scenario.

Functions

  • Subscription: After a customer purchases a product and pays for it successfully, KooGallery calls this interface to send you a request containing information about the product and customer. When receiving the request, the ISV server executes product subscription and informs KooGallery about the subscription result.
    NOTE:

    When a customer clicks the View Resource Details button on the Purchased Apps page, KooGallery calls the subscription interface in real time to query the product information. Therefore, the ISV server needs to perform idempotence processing when processing requests. KooGallery may resend requests for a single order. If receiving a duplicate order, your server needs to return a success response and the information about the successfully created app instance, rather than create a SaaS instance.

  • Renewal: After a customer places an order for renewal or converts a trial order to a commercial order, KooGallery calls the interface to request you to extend the service. The service interface then updates the expiration date and informs KooGallery about the update result.
  • Expiration: When a purchased product expires, KooGallery calls the interface to send you a notification. After receiving an expiration notification, you must freeze the purchased product and inform KooGallery about the freezing result.
    NOTE:

    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.

  • Resource release: If a customer does not renew an expired product in the retention period, or the customer has unsubscribed from the product, KooGallery releases the purchased product and calls the interface to send you a notification. Upon receiving the notification, delete the specified instances and inform KooGallery about the deletion result.
  • Upgrade: After a customer places an order for upgrading a purchased product, KooGallery calls the interface to request you to upgrade the product. The ISV server then upgrades the product and informs KooGallery about the upgrade result. The upgrade scenario is optional.
  • After a customer purchases a pay-per-use product (or package), when the instance expires, the customer violates regulations, or the customer account is in arrears, KooGallery calls this interface to freeze the instance.

Interface Failure Scenarios and Retry Mechanism

  • In subscription and upgrade scenarios, if the service interface fails to respond, KooGallery will retry for 3 hours.

    If the interface exception is rectified, the next call will be successful and the order will be placed successfully. If the exception persists after 3 hours, KooGallery determines that the order fails to be placed and automatically cancels the order.

  • In the renewal scenario, if the service interface fails to respond, KooGallery will retry for an hour.

    If the interface exception is rectified, the next call will be successful and the order will be placed successfully. If the exception persists after an hour, KooGallery determines that the order fails to be placed. In this case, locate and rectify the exception. Then go to the Seller Console, locate the order on the Application Tools > Service Interface Messages page, and click Restart Debugging in the same row to call the interface again.

  • In product expiration and resource release scenarios, if the service interface fails to respond, KooGallery will retry for an hour.

    If the interface exception is rectified, the next call will be successful and the order will be placed successfully. If the exception persists after an hour, KooGallery determines that the order fails to be placed. In this case, locate and rectify the exception. Then go to the Seller Console, locate the order on the Application Tools > Service Interface Messages page, and click Restart Debugging in the same row to call the interface again.

    If a customer can still use expired resources due to an interface failure, you shall bear the resource loss incurred.

    NOTE:

    If the service interface fails to respond, an email, SMS message, and private message will be sent to you. Check the email address and mobile number bound to your account and the Message Center on Huawei Cloud.

    If more than five orders failed in a month due to interface failures, KooGallery will remove the product from the catalog.

    If an order is automatically canceled due to an interface failure, contact the customer at the earliest to handle the problem.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback