Skip to main content

SDK overview

OptoLink ships official SDKs so your app can create and resolve short links without talking raw HTTP. Every SDK covers the same core: link management, short-URL handling, and QR codes, authenticated against your OptoLink organization.

Platform matrix​

PlatformPackage / moduleDocs
Flutteroptolink_flutter (git dependency)Install & initialize
Node.js@optomatica/optolink-sdk (npm)Install & initialize
Androidcom.optomatica:optolink-android (Maven Central)Install & initialize
iOSOptomatica/optolink-ios-sdk (SPM)Install & initialize

Requirements​

PlatformRequirementsBackend compatibility
Node.jsNode ≥ 18 (native fetch); SERVER-tier API key (opl_api_…)v2.1.0+
FlutterFlutter ≥ 3.38 · iOS 15+ / Android minSdk 23 · CLIENT-tier key (opl_sdk_…)v2.1.0+
AndroidminSdk 23 · CLIENT-tier key (opl_sdk_…)v2.1.0+
iOSiOS 15+ · CLIENT-tier key (opl_sdk_…)v2.1.0+

The Node SDK is a zero-dependency TypeScript client for the /links API — CRUD plus QR codes — for server-side and tooling integrations. The Flutter SDK lives inside your mobile app: it handles deep links, deferred deep linking across the install flow, and link resolution. The Android SDK is the native-Kotlin counterpart for Android apps: verified App Links, deferred matching, and identity/event telemetry. The iOS SDK is the native-Swift counterpart for iOS apps: verified Universal Links, deferred matching, and identity/event telemetry.

Docs pattern​

Each platform's docs follow the same slot pattern, so once you know one SDK's docs you know where to look in the other:

Authentication basics for every SDK live in API reference → authentication.