Device Fingerprint
Using the dashboardQuick Start

Integrated SDK

Quick Start: Integrated SDK

Geelab provides Web, iOS and Android client SDKs respectively. Please choose the SDK that matches the integration platform and do not mix Public API Keys across platforms.

Supplementary requirements before release The current product information does not include the confirmed SDK package name, minimum version, installation command, initialization method and formal code example. The code blocks in this section are document placeholder structures and cannot be directly published as executable code. Before official release, it must be completed and verified by the SDK person in charge according to the current stable version.

General initialization parameters

Parameter names may vary between platforms, but generally require the following information:

ParametersIs it requiredDescription
Public API KeyYesCopied from the current endpoint, used to identify the source of client requests
Region or API EndpointDepends on the SDKMust be consistent with the Region to which the application belongs
TimeoutRecommended settingsAvoid identification requests blocking business processes for a long time
Business related fieldsDepending on business needsUsed to associate accounts, orders or operation scenarios; do not upload unnecessary sensitive information
Debug logTest environment onlyIt is recommended to close or desensitize the formal environment

Initialization principle:

  • Complete SDK initialization before the business process that needs to be identified.
  • Public API Key must come from the endpoints corresponding to the current platform.
  • Do not pass the Region server key to the client SDK.
  • There should be a business degradation plan when identification fails, and SDK exceptions should not cause the entire page or app to crash.
  • Key actions such as login and transaction should be saved request_id, used for subsequent server-side query and troubleshooting.

Web SDK quick access

Step 1: Install or load SDK

Please use the package manager command or loading method provided by the Geelab Web SDK official documentation.

# To be supplemented and verified by the person in charge of SDK: Web SDK installation command

Step 2: Initialize SDK

// Example structure, non-executable code. Please replace with the official SDK API.
const client = initializeGeelab({
  publicKey: "<YOUR_PUBLIC_API_KEY>",
  region: "<YOUR_REGION>"
});

Step 3: Initiate identification

// Example structure, non-executable code. Please replace with the official SDK API.
const result = await client.identify();

console.log(result.requestId);
console.log(result.deviceId);

It is recommended to temporarily record the Request ID in the test environment and close non-essential logs containing device information after successful verification.

iOS SDK quick access

Step 1: Add SDK dependencies

Please follow the official iOS SDK documentation to add the SDK through the currently supported dependency management methods.

// To be supplemented and verified by the person in charge of SDK: iOS SDK installation and import code

Step 2: Initialize and initiate identification

// Example structure, non-executable code. Please replace with the official SDK API.
let client = GeelabClient(
    publicKey: "<YOUR_PUBLIC_API_KEY>",
    region: "<YOUR_REGION>"
)

client.identify { result in
    // Read requestId and deviceId
}

Confirm that the App's Bundle ID is exactly the same as the value configured on the endpoints. If the beta version and the official version use different Bundle IDs, please verify them separately.

Android SDK quick access

Step 1: Add SDK dependencies

Please follow the official Android SDK documentation to add the current stable version dependency to your project.

// To be added and verified by the SDK person in charge: Android SDK Gradle dependencies

Step 2: Initialize and initiate identification

// Example structure, non-executable code. Please replace with the official SDK API.
val client = GeelabClient(
    publicKey = "<YOUR_PUBLIC_API_KEY>",
    region = "<YOUR_REGION>"
)

client.identify { result ->
    // Read requestId and deviceId
}

Confirm that the Package Name and App Signature of the actual installation package are consistent with the endpoints configuration. Pay special attention to the fact that Debug and Release builds may use different signatures.

Integrate the identification results into the business process

After the client receives request_id and device_id, send request_id to your server with the business request. The server can use it to query trusted event details and apply risk strategies based on the account, order, or operation context.

Client SDK identification

   ├── request_id
   └── device_id

Customer business server

   ├── Associate account / order / action
   ├── Query trusted details through the Server API
   └── Decide to allow / challenge / restrict / block

Do not rely solely on self-reported risk results from clients to make high-risk decisions. When it comes to login, transaction or rights issuance, it is recommended that the trusted server query or verify the event results.

Illustration: client and server data flow