FAQ
- Why is the following error message displayed when I debug the service interface?
Debugging failed. The production interface response does not contain Body-Sign or the Body-Sign format is incorrect.
- KooGallery fails to obtain the Body-Sign message header. Add Body-Sign to the response of the interface. For details, see HTTP Body Signature. You must return the Body-Sign header, which is case sensitive. Otherwise, the debugging fails, for example, when Body-sign is returned.
- KooGallery fails to obtain the values of sign_type and signature from the Body-Sign header. Check whether the value format is incorrect. Correct format:
sign_type="HMAC-SHA256", signature="******"
If the quotation marks ("") are missing, KooGallery cannot retrieve the two values and displays this error message.
- Why is the following error message displayed when I debug an interface?
Call interface failed. The production interface returns an error result code.
By default, resultCode=000000 indicates a successful call. Other codes indicate a failure. For details about error codes, see Result Codes.
- Why is the following error message displayed when I debug an interface?
Debugging failed. The interface response does not contain {fileId}.
KooGallery verifies whether a response contains these mandatory fields:
- Interface for subscribing to a product: instanceId and frontEndUrl
- Interface for querying instance information: instanceId. If it returns UsageInfo, it must also return usageValue and statisticalTime.
- Why is the following error message displayed when I debug an interface?
Debugging failed. The length of {fileId} is invalid.
KooGallery verifies the length of response field values. For example, the value of frontEndUrl returned by the subscription interface can contain up to 512 characters. For details about the length limits, see Interface Description.
- Why is the following error message displayed when I debug an interface?
Debugging failed. Parse response body failed. Example response: {"resultCode":"000000","resultMsg":"success."}
KooGallery fails to parse the response. The interface does not return resultCode and resultMsg.
- Why is the following error message displayed when I debug an interface?
Debugging fails. Invalid content-type format. Returned format: {contentType}. Valid format: "application/json"
The value of content-type in the response must be "application/json". Otherwise, KooGallery will fail to parse the response body.
- Why is the following error message displayed when I debug an interface?
Debugging failed. The production address is unreachable.
- Check whether the production address is available.
- Check whether the production address can be accessed from the Internet.
- Check whether the access is intercepted by the gateway.
- Why is the following error message displayed when I debug an interface?
Debugging failed. Interface calling timed out for 20s.
The default timeout interval for KooGallery to call your interfaces is 20s. Calls that take longer than 20s will fail.
View logs and check whether the request reached the server. If it did, check whether the response time exceeds 20s. If it did not reach the server, contact after-sales engineers.
- Why is the following error message displayed when I debug an interface?
Debugging failed. The interface responds with httpCode={httpCode}. Check server logs to locate the failure cause.
By default, httpCode=200 indicates a successful call. Other codes indicate a failure.
-
Why is the error message "Failed to verify the HTTP Body signature. Expected signature value: **********" displayed when I debug the service interface?
This is because the HTTP body content changes after the signature is obtained and before the message is sent. The possible causes of the change include attribute sequence changes, a blank space added, and a newline character added (\n is added to some output streams). Troubleshoot the issue based on the causes.
-
When the verificateRequestParams method is invoked, authToken and signature are inconsistent, and plus signs (+) become spaces. What should I do?
Invoke URLDecoder.decode() to decrypt authToken and signature.
- Why can't a SaaS product customer view the username and password of the product when they click Manage on the My KooGallery Apps > Purchased Apps page?
Possible causes are as follows:
- When the instance is enabled, some parameters failed the verification. For example, the length of the password is incorrect. The length of the password ciphertext must not exceed the limit defined in this guide.
- KooGallery failed to decrypt the username and password. Sellers must use the method provided by KooGallery to encrypt sensitive information. If a seller uses a different programming language, check whether the ciphertext generated using the current language is the same as the ciphertext generated using the code provided by KooGallery. If they are the same, check whether the encryptType parameter for encrypting and decrypting sensitive information is correctly transferred to KooGallery. If the algorithm is AES256_CBC_PKCS5Padding, the value must be 1. If the algorithm is AES128_CBC_PKCS5Padding, the value must be 2.
- Why is the authToken generated by encrypting the request parameters provided by KooGallery different from the authToken provided by KooGallery?
Parameters in a requested URL are URL-encoded and cannot be directly used to generate the authToken. Decode each parameter first, and use the decoded parameters to generate the authToken. A customer's mobile number and email address remain as ciphertext after being decoded and do not need to be decrypted again.
- Does the restriction on the username and password lengths apply to the plaintext or ciphertext?
It applies to the ciphertext (including the IV). Sometimes the instance of a product is successfully enabled but the username and password lengths fail the KooGallery verification. As a result, the status of the product is displayed as Enabling on the My Orders page. To prevent this issue, verify the lengths of the encrypted username and password.
- After a customer purchases and pays a SaaS product, KooGallery still fails to enable the instance by invoking the subscription interface of the seller when the number of invocation times reaches the maximum. What do I enable the instance?
Identify why the instance fails to be enabled and fix the problem. Then, log in to the Seller Center, choose Application Tools > Service Interface Messages in the navigation pane, and click Restart Debugging on the right.
- After I debug the subscription interface on the Application Access Debugging page, do I need to do anything else that should be done?
To ensure that smooth subsequent service processes such as renewal, expiration, and release, debug all of the subscription, renewal, expiration, and release interfaces before releasing a SaaS product to KooGallery.
- When releasing a SaaS product, where can I specify the algorithm sensitive information encryption performed during application access debugging?
On the SaaS product release page, after you select User Authorization Required, the algorithm for encrypting sensitive information is displayed. By default, AES256_CBC_PKCS5Padding is selected. You can choose another encryption algorithm as required.
- What can I do if the subscription interface is successfully debugged but it cannot be invoked when a customer purchases a product?
- Log in to the Seller Console, choose Application Tools > Application Access Debugging in the navigation pane. Use the actual request sent by KooGallery to the customer and the actual message body returned to KooGallery to debug the subscription interface on the Application Access Debugging page.
- If the debugging is successful, choose Application Tools > Service Interface Messages in the navigation pane of the Seller Console and click Restart Debugging on the right of the corresponding record. Otherwise, contact the operations manager.
- Can multiple production system API URLs be provided for different scenarios (subscription, renewal, expiration, and release) when a product is released?
No. Currently, only one production system API URL can be configured for a product during release.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot