Skip to content

Server API ​

This module is the contract reference for all APIs between the APP server and SUD OP SVR. Before integrating, please read Server Integration to understand the overall flow.

Service Regions and API Addresses ​

Open API documents list request methods and API paths. Before calling an API, select the base URL for your application's service region. See Service Regions and API Addresses.

Security Mechanisms ​

APIs in this module fall into two categories: mandatory encryption and signing and plaintext calls. APIs with mandatory encryption and signing must complete request encryption and signing plus callback signature verification; be sure to configure the corresponding keys and public keys before integrating. Plaintext-call APIs are neither encrypted nor signed and are called directly as standard HTTPS requests. See Server API Signature and Encryption for the full specification (requests and callbacks share the same "application public/private key / SUD OpenPaaS certificate").

  • Request encryption and signature (Open API → SUD OP SVR): The APP server first encrypts the request body with a symmetric key, then signs the ciphertext with the application private key. Requests that are not encrypted, not signed, or fail signature verification are rejected.
  • Callback signature verification (SUD OP SVR → APP server): The APP server verifies the callback request signature using the public key from the SUD OpenPaaS certificate. If verification fails, reject the request directly.
  • Plaintext-call APIs: Requests and responses are all plaintext; no encrypted payload or signature headers are needed, and no response decryption or signature verification is required.
  • Key overview: See Key Description.

Open API ​

Open - API Call Credential ​

NameDescription
auth.getAccessTokenObtain the API call credential

Open - Game ​

NameDescription
game.getSignatureObtain the signature data of a specified game

Open - Payment ​

NameDescription
pay.notifySync payment result to SUD
pay.refundNotifySync refund result to SUD

Open - Ad ​

NameDescription
ad.rewardNotifyReport rewarded video completion

Webhook ​

Webhooks are implemented by the APP server and their callback URLs are configured in the SUD OP console. SUD calls them when the corresponding business events are triggered. SUD does not restrict the domain or path of the callback URL; it only requires the APP to receive requests using the HTTP method and request body format specified in each API document below, and return data in the specified response format.

Must read: All callback requests carry the SUD OpenPaaS signature. The APP server must first complete signature verification using the SUD OpenPaaS certificate before trusting the callback content (see Server API Signature and Encryption). Processing a callback without signature verification carries the risk of forged request attacks.

Webhook - Payment ​

NameDescription
pay.orderQueryQuery order status
pay.refundRequest refund
pay.refundQueryQuery refund status

Webhook - Ad ​

NameDescription
ad.rewardQueryQuery rewarded video completion