REST API

Use the REST API for server-side automation or platforms that do not yet have an SDK.

Integration options

Official SDKs (recommended)

Whenever possible, use the native SDKs so installation tracking, session management, and retries happen automatically:

• iOS SDK
• Android SDK
• Flutter plugin

Direct API integration

If you are building a backend service or unsupported client, follow the Direct Integration Guide.

Quick reference

Authentication

X-App-Key: your-api-key
Content-Type: application/json

Base URL

https://api.ulink.ly

Core endpoints

Endpoint	Purpose
POST /sdk/installations/track	Track app installations
POST /sdk/sessions/start	Start a session
POST /sdk/sessions/{id}/end	End a session
POST /sdk/links	Create dynamic/unified links
GET /sdk/resolve?url=…	Resolve link data

API key

Create or rotate keys under Dashboard → API Keys. Store them in your backend only.

Error codes

Code	Meaning
UNAUTHORIZED	Invalid/missing API key
PRECONDITION_REQUIRED	Missing installation context
FORBIDDEN	Plan limit exceeded
NOT_FOUND	Resource not found
VALIDATION_ERROR	Invalid request payload

Next steps

1. Read the Direct Integration Guide for full request/response examples.
2. Implement installation tracking and session management first; other endpoints depend on that context.***