Developer Guide
This guide covers everything you need to integrate Tolinku into your app. Use the REST API for server-side operations and the SDKs for client-side deep linking, analytics, and in-app messaging.
Base URL
Section titled “Base URL”All API requests use:
https://your-app.tolinku.com/v1/apiReplace your-app.tolinku.com with your Appspace’s domain (subdomain or custom domain).
Authentication
Section titled “Authentication”API requests are authenticated with API keys sent via the X-API-Key header. There are two key types:
- Publishable keys (
tolk_pub_): Safe for client-side code. Limited to read operations and event tracking. - Secret keys (
tolk_sec_): Server-side only. Full access to all endpoints.
See Authentication for details.
What you can do
Section titled “What you can do”| Feature | Description |
|---|---|
| Deep Links | Resolve and claim deep links programmatically |
| Analytics | Query metrics, export data, track custom events |
| Referrals | Create referral codes, track milestones, claim rewards |
| Banners | Fetch active smart banners for your app |
| Messages | Fetch and render in-app messages |
| Audiences | Check segment membership, list users |
| Webhooks | Receive real-time event notifications |
Official SDKs handle deep link resolution, event tracking, deferred deep linking, and in-app messaging out of the box.
| Platform | Package | Registry |
|---|---|---|
| Web (JS/TS) | @tolinku/web-sdk | npm |
| iOS (Swift) | TolinkuSDK | Swift Package Manager |
| Android (Kotlin) | com.tolinku:sdk | Maven Central |
| React Native | @tolinku/react-native-sdk | npm |
| Flutter (Dart) | tolinku | pub.dev |
Next steps
Section titled “Next steps” Quick Start Get your first API call working in minutes.
API Reference Full endpoint documentation.
SDKs Platform-specific SDK guides.
Webhooks Real-time event notifications.