API Reference

ULink provides SDK API endpoints designed for mobile app integration and server-side access. Choose your integration method based on your needs:

Integration Methods

🚀 Official SDKs (Recommended)

For mobile applications, use our official SDKs that handle installation tracking, session management, token persistence, and error handling automatically:

• Flutter SDK - For Flutter applications
• Coming Soon - iOS, Android, React Native, and Web SDKs

⚙️ Direct API Integration

For custom implementations, server-side usage, or unsupported platforms:

• Direct Integration Guide - Complete implementation guide with MAU tracking
• Requires manual token management and session handling
• Includes production-ready code examples

Quick Reference

Authentication

All SDK API endpoints (/sdk/*) use X-App-Key authentication:

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

Base URL

https://api.ulink.ly

Core Endpoints

Endpoint	Purpose
POST /sdk/installations/track	Track app installation
POST /sdk/sessions/start	Start user session
POST /sdk/sessions/{id}/end	End user session
GET /sdk/resolve?url=...	Resolve link data
POST /sdk/links	Create new link

Getting Your API Key

1. Sign up at ULink Dashboard
2. Create a project
3. Navigate to API Keys section
4. Click "Create API Key"
5. Copy and store the key securely

Security

Never expose API keys in client-side code or commit them to version control.

Error Codes

Code	HTTP Status	Description
UNAUTHORIZED	401	Invalid or missing API key
PRECONDITION_REQUIRED	428	Missing installation context
FORBIDDEN	403	Usage limit exceeded
NOT_FOUND	404	Resource not found
VALIDATION_ERROR	400	Invalid request parameters

Next Steps

1. Mobile Apps: Start with our Flutter SDK for the easiest integration
2. Custom Integration: Follow the Direct Integration Guide for complete implementation
3. Need Help?: Contact us through our support form

---

For detailed implementation guides, code examples, and best practices, see the Direct Integration Guide.