Documentation

Everything you need to integrate Wee-Kit deep links into your mobile apps.

Quick Start GuideAPI Reference

Quick Start

Get up and running in minutes. Create your first deep link.

API Reference

Complete REST API documentation with code examples.

Deep Linking

Universal Links (iOS) and App Links (Android) setup guide.

Deferred Deep Links

Route users to content even after app installation.

Custom Domains

Use your own branded domain for all deep links.

Analytics

Track clicks, platforms, and user behavior in real-time.

Quick Start Guide

Create your first deep link in under 5 minutes.

1

Create an account

Sign up for a free account. You'll get a 30-day trial with full access to all features.

Create free account →
2

Create your app

Add your mobile app in the dashboard. You'll need your iOS Bundle ID and/or Android Package Name.

iOS Bundle ID

com.yourcompany.yourapp

Android Package

com.yourcompany.yourapp

3

Get your API credentials

Navigate to your app settings and generate API credentials. You'll receive:

X-API-KeyPublic key for identifying your app
X-API-SecretSecret key for authentication (keep this secure!)
4

Create your first link

Use the API to create a deep link programmatically:

curl -X POST https://api.wee-kit.app/v1/links \
  -H "X-API-Key: dk_live_your_api_key" \
  -H "X-API-Secret: sk_live_your_api_secret" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://myapp.com/product/123",
    "title": "My First Deep Link"
  }'
5

Test your link

The API returns a short URL like https://yourapp.wee-kit.app/l/abc123. Open it in a browser to verify it redirects correctly.

Success! Your deep link is now live. Share it anywhere and track clicks in real-time from your dashboard.

Ready to explore more?

View Full API Reference

Deep Linking

Universal Links (iOS) and App Links (Android) allow your app to claim ownership of URLs, enabling seamless transitions from web to app.

iOS Universal Links

  • Add Associated Domains capability
  • Wee-Kit hosts your apple-app-site-association file
  • Handle incoming links in SceneDelegate

Android App Links

  • Add intent filter in AndroidManifest.xml
  • Wee-Kit hosts your assetlinks.json file
  • Handle incoming intents in Activity

Need help?

Have questions or need assistance? We're here to help.

Contact Support