On this page
Choose an integration
Start with what your application needs to connect to. The wallet Provider API, Hardware SDK, and QR SDK serve different integration paths.
| You want to… | Use | Start here |
|---|---|---|
| Let users connect their OneKey wallet to a website or dApp | A chain-specific wallet provider or a wallet UI library | dApp quickstart |
| Connect your own wallet or app directly to a OneKey device | Hardware SDK with a transport for your runtime | Hardware SDK quickstart |
| Exchange signing requests with a QR-capable device | Air-Gap SDK | QR signing overview |
A dApp integration asks the OneKey wallet to manage the user’s accounts and signing flow. A direct hardware integration makes your application responsible for device discovery, connection state, UI events, and transaction preparation.
Connect a dApp
- Install OneKey in your development environment.
- Follow the dApp quickstart to detect the provider and request accounts from a user action.
- Choose your chain in the Provider API reference. Methods and return values differ by chain.
- Handle a missing wallet, an empty account list, a rejected request, and account or network changes.
If your application already uses a wallet UI library, start with its OneKey integration. For mobile handoff, read Mobile and deep links.
Connect hardware directly
Choose your runtime before installing an SDK:
| Runtime | Guide |
|---|---|
| Browser with WebUSB support | WebUSB |
| React Native with Bluetooth | React Native BLE |
| Native Android, iOS, or Flutter | Native mobile integration |
Then follow the quickstart. Initialize the SDK, handle its UI requests, select a device, and retrieve an address before moving on to signing. Check device and chain support for the exact method and device you plan to use.
The hardware playground is useful for exploring APIs. An emulator or a successful build does not replace testing your integration with the intended device, firmware, and runtime.
Use QR signing
Start with the Air-Gap overview, then follow a chain-specific guide such as Ethereum and EVM. Your app encodes a request, displays it as QR data, reads the device’s response, and validates the result before broadcasting through its own network connection.
Before you ship
- Test rejection, cancellation, disconnect, and reconnect as well as the successful path.
- Show the account and network being used. Preserve the user’s opportunity to review signing requests.
- Never collect recovery phrases or private keys. Keep PINs, passphrases, tokens, and wallet-session data out of logs and bug reports.
- Pin and record the versions used in your integration. Re-test after SDK, firmware, or wallet upgrades.
- Use the troubleshooting guide when a request fails or stalls.