Key Description
This document serves as the master index of the various keys involved in the OpenPaaS integration process, categorized into three groups by "acquisition entry point / scope of use". Only the key points are listed for each category; see the corresponding topic documents for detailed specifications.
1. App (APP) Basic Information
Obtained directly when creating an app; globally applicable.
| Key Name | Purpose | User | Confidential? |
|---|---|---|---|
| appid | Unique app identifier | APP Client / Server | No (public identifier) |
| appkey | Used during APP client SDK initialization | APP Client | No |
| appsecret | Used when the APP server calls auth.getAccessToken to exchange for an access_token | APP Server | Yes |
Derived credential
access_token: Obtained by the APP server usingappsecretto call auth.getAccessToken, and used as the calling credential for all subsequent S2S open interfaces. It is a dynamic, short-lived credential (expires_inis typically 7200 seconds) that should be cached and reused rather than re-fetched on every call. See the "Best Practices and Credential Management" section of the interface documentation for the complete credential management and concurrent refresh specifications.
2. Data Security
Keys for encryption/decryption and signing/verification during the flow of app business data.
| Key Name | Purpose |
|---|---|
| Data symmetric encryption key | Symmetric encryption/decryption of sensitive data such as sessionKey and userSignature |
| Data signature key pair | Verification of signed business data payloads such as gameSignature |
Detailed configuration and usage specifications: Data Security Key Description
3. API Security
Keys used for S2S interface communication between the server and SUD OP SVR (including open interfaces and callback interfaces): the symmetric key, app key pair, and SUD OpenPaaS certificate.
Detailed configuration and usage specifications: Server API Signature and Encryption (calling direction) and Callback Signature and Encryption (callback direction, which uses exactly the same keys with the signer and verifier swapped).
4. Data Security vs API Security
The two categories of keys are completely independent, generated and downloaded on different configuration pages in the management console, with non-overlapping scopes:
- Data security keys serve "business data payloads": encryption/decryption of sessionKey / userSignature, and verification of signed fields such as gameSignature;
- API security keys serve "S2S HTTP messages": AES-256-GCM encryption and RSASSA-PSS signing of the entire request/response of open interfaces and callback interfaces.
Do not mix the two sets of keys.
