release-checklist.md

Integration Checklist

Language: English | 简体中文

Use this checklist after configuring the SDK or Sample to confirm the basic integration.

SDK and Application

• The application uses JDK 17 or later.
• Applications using the Sample configuration run Spring Boot 3.x.
• The SDK source is copied into the project, or the SDK dependencies resolve from a local or private Maven repository.
• Source integration includes the OkHttp transport META-INF/services SPI file.

Endpoint and Credentials

• Technical support supplied an endpoint beginning with http:// or https://.
• No individual /remoteApi/* path is appended to the endpoint.
• Technical support supplied either an Access Token or an AppKey and SecretKey pair.
• Exactly one of Token and signature authentication is enabled.
• Real credentials are not committed to version control or written to logs.

First Calls

• Calls to the same platform with the same credentials reuse one Client; Spring applications use a singleton bean.
• The Client calls close() when the application stops.
• client.system().getTimeText() succeeds.
• At least one Inventory query succeeds.
• Pagination requests use pageNo.
• Exception logs contain only necessary fields such as requestId, operation, code, and resultUnknown.

Optional Capabilities

• File downloads use OutputStream, never load the complete file into a byte[], and discard incomplete output before restarting.
• A write or control failure with resultUnknown=true is confirmed before any repeat attempt.
• The Sample's eleven write/control operations remain disabled unless sample.dangerous-operations-enabled=true is explicitly configured.
• When MQ is required, technical support has supplied the NameServer and confirmed the topic and message permissions.
• MQ handlers tolerate duplicate messages and never log the raw message body.