Developer API & SDK Documentation

Build with
OneLink API

Automate link creation, track analytics, and manage your app growth programmatically with our developer-first API.

Safe & Secure Auth

X-API-KEY: ol_live_...
X-API-SECRET: sk_live_...

Fast Links

Create thousands of links in seconds via our API.

Analytics

Real-time click tracking across all platforms.

Access Control

Our API uses a secure dual-header authentication system. To authorize your requests, generate a key pair in your dashboard and include them in every HTTP request.

Authentication Example

X-API-KEY: ol_2c.................................................
X-API-SECRET: bda1.................................................

Required Headers

Zero-Trust Architecture

We store only the cryptographic hashes of your secrets. This ensures that your actual keys are never visible to anyone—even our system administrators. Always store your secret securely as it can only be viewed once.

API Gateway

All endpoints are built on a high-concurrency infrastructure designed for 99.99% uptime. Routes are versioned to ensure backward compatibility.

https://1ne.io/api/v1/dev

POST /links

Create Smart Link

Programmatically generate a redirection node that handles multiple platforms. This example demonstrates how to set up a "Demo App" campaign with full metadata support.

Request Parameters

linkNameFriendly name for internal tracking.

slugUnique URL identifier.

brandNameDisplay name for the brand.

brandLogoUrlLink to your app icon/logo.

fallbackUrlDefault redirect for desktop/other.

deepLinkPathInternal app route (e.g. spotify:playlist:123). This tells the device which specific screen to open inside the app.

appStoreLinksPlatform specific app store URLs.

utmParamsUTM tracking parameters.

curl -X POST https://1ne.io/api/v1/dev/links \
  -H "X-API-KEY: ol_2c................................................." \
  -H "X-API-SECRET: bda1................................................." \
  -d '{
    "linkName": "Demo App: Today\u0027s Top Hits",
    "slug": "demo-top-hits",
    "brandName": "DemoMusic",
    "brandLogoUrl": "https://upload.wikimedia.org/wikipedia/commons/1/19/Spotify_logo_without_text.svg",
    "fallbackUrl": "https://music.example.com/playlist/37i9dQZF1DXcBWNGSRBgas",
    "deepLinkPath": "demomusic:playlist:37i9dQZF1DXcBWNGSRBgas",
    "appStoreLinks": [
      { "platform": "ios", "url": "https://apps.apple.com/app/demo-music/id123" },
      { "platform": "android", "url": "https://play.google.com/store/apps/details?id=com.demo.music" }
    ],
    "utmParams": {
      "baseUrl": "https://music.example.com/playlist/37i9dQZF1DXcBWNGSRBgas",
      "source": "api_campaign",
      "medium": "smart_link"
    }
  }'

Comprehensive Implementation

Success Response

{
  "status": "success",
  "data": {
    "id": "lnk_9872",
    "slug": "demo-top-hits",
    "publicUrl": "https://1ne.dev/demo-top-hits"
  }
}

GET /links/:slug/stats

Real-time Performance

Retrieve detailed breakdowns of visitor data. This endpoint returns click volume, platform distribution (MacOS, Windows, iOS, Android), and top referrers including social app detection.

Geo Data

Fetch visitor country and city metrics for global tracking.

Platform Split

Track OS, device type, and social app distribution.

{
  "totalClicks": 12500,
  "platforms": {
    "ios": 4500,
    "android": 3500,
    "macos": 2500,
    "windows": 1800,
    "other": 200
  },
  "topReferrers": [
    { "source": "Instagram", "count": 2100 },
    { "source": "WhatsApp", "count": 1800 },
    { "source": "LinkedIn", "count": 920 }
  ],
  "timeline": [
    { "date": "2024-12-01", "clicks": 450 },
    { "date": "2024-12-02", "clicks": 520 }
  ]
}

Analytics Payload Response

BUILD AT SCALE

Unlock Elite API Limits

Ready to automate your enterprise growth? Upgrade to our highest tier for dedicated support, custom rate limits, and priority API gateway access.

View Enterprise Plans

Build with OneLink API