DDoS-protected SDK Access Overview and integration testing Checklist

Organize client platform, version and network information, obtain matching SDK documents, and complete testing, phased rollout and rollback verification.

Contents of this article

First confirm whether the SDK matches the project

SDK ShieldUsed for client access to games and APPs. The product description of this site lists Windows, Android, and iOS. The specific SDK version, system version, development framework, and protocol adaptation range need to be confirmed with the technical consultant according to the project.

Before accessing, obtain the SDK, version documents and authorization information that match the project, and complete the integration according to the corresponding version documents.

For common checking items for accounts, lines and orders, see Purchase requirements and billing

Conditions that should be met before accessing

  • Able to modify and build client projects, arrange testing and version releases.
  • There are server and test business processes that can be jointly debugged, and necessary client and server error information can be obtained.
  • Clarify the target system, application framework, connection protocol, and existing login, authentication, and reconnection mechanisms.
  • There is a recovery arrangement for the original version or the original connection plan, which can distinguish the running results of the old and new clients.
  • The applicable platform, authorization scope, number of origin servers, business scale and fees have been confirmed with customer service, and the actual access package and documents have been obtained.

Information provided when applying for access

Information Fill in the content
Application information Game or APP name, usage scenario, and platform to be connected to
Build environment Operating system version range, development language, engine or framework, compilation tools and architecture
Connection method Server address, protocol, port, connection duration, authentication and reconnection method
Business scale Daily active users, concurrent connections, peak bandwidth, main user areas and number of origin servers
external dependencies Login, payment, update, push and other services that require joint verification
integration testing plan Test environment, client build version, online window and responsible personnel

If application identification, package name or signature information is required for delivery, it should be provided in the fields given by the service team. Authorization credentials and keys are processed through agreed channels and are not written into public problem descriptions.

What deliverables should be obtained

Before starting to modify the code, check the following information with the technical staff:

  1. SDK supported platforms, versions, dependencies and upgrade compatibility instructions.
  2. Officially distributed SDK package, sample or minimal access process, and version identification method.
  3. The authorization method, initial configuration and business connection range that need to be accessed for this project.
  4. Error codes, log collection methods, integration testing contact channels and troubleshooting instructions.
  5. Behaviors to watch out for when releasing, upgrading, decommissioning, and rolling back.

Recommended access sequence

  1. Establish a baseline. Record the startup, login, connection time, business success rate and exception information of the original client version.
  2. Access the test version. Integrate the SDK according to the delivery document, confirm that the construction, initialization and connection are completed, and then connect to the complete business process.
  3. Completed integration testing. Cooperate with the service team to check the request path, authorization results and server behavior, and handle compatibility issues one by one.
  4. Release on a small scale. Use the existing publishing capabilities of the project to open it to some test users to observe different systems, devices and network environments.
  5. Expand the scope of use. Release after meeting the pre-agreed acceptance criteria, and keep version and configuration records.

How to verify successful access

scene Results to be observed
Startup and login Cold start, repeated startup and login can be completed, and corresponding errors can be collected when they fail.
business connection Both the client and the server can confirm normal sessions, and the key operation results are consistent.
network changes Wi-Fi and mobile network switching, short-term network disconnection, timeout and reconnection under weak network are in line with business expectations
system behavior After switching between front and back, waking up from sleep, or being idle for a long time, the business resumes as expected.
Version compatible The systems, architectures and client versions to be supported have been tested separately.
external process Login, payment, update and other dependencies did not fail due to changes in the connection scheme.
rollback The original version or the agreed recovery plan can be used, and the core process can be completed again after recovery.

During integration testing, check the scheduling, encryption and fault recovery behavior of the SDK version used, and record the test results.

Submit issues and rollbacks

When an exception is encountered, the SDK version, application version, system and device, network environment, occurrence time, recurrence steps and desensitization logs are recorded to explain whether the same scenario is normal in the original version. The error code is explained according to this delivery document.

Stop expanding the scope or restore the original version according to the pre-verified plan; whether it is necessary to adjust the server or authorization configuration after deactivating the SDK will be confirmed by the service team.

PassOnline customer serviceExplain "SDK access integration testing" and submit the platform, construction environment and business information; see other existing channelsContact us

Return to SDK documentation Return to help center Contact technical support