Skip to main content

Getting Started

Use this checklist to set up any ULink project, regardless of platform.

1. Create a project​

  1. Log into the ULink dashboard.
  2. Click New Project and give it a descriptive name.
  3. Invite teammates if multiple people will manage links.

Get an API key​

  1. Inside the project, open Settings → API Keys.
  2. Click Generate API Key.
  3. Copy the key to a secure place—you’ll need it for the SDK configuration steps below.

2. Configure domains​

  1. Navigate to Domains → Add Domain.
  2. Pick a shared .shared.ly subdomain or connect your custom domain.
  3. For custom domains, finish DNS verification before continuing.

3. Configure platform settings​

Navigate to Configuration → General in your project dashboard to configure platform-specific settings. These are required for Universal Links (iOS) and App Links (Android) to work.

iOS Configuration​

  • Bundle ID — Your app's bundle identifier (e.g., com.yourapp.app)
  • Team ID — Your Apple Developer Team ID (a 10-character string like ABC123DEF4)
  • URL Scheme — Custom URL scheme for deep linking (e.g., myapp://)

See the iOS guide for detailed instructions on finding these values.

Android Configuration​

  • Package Name — Your app's package name (e.g., com.yourapp.app)
  • SHA-256 Fingerprints — Certificate fingerprints for App Links verification
  • URL Scheme — Custom URL scheme for deep linking (e.g., myapp://)

See the Android guide for detailed instructions on finding these values.

Why These Settings Matter

ULink automatically generates and serves the verification files required by iOS (AASA) and Android (assetlinks.json). These files use your configured settings to associate your domain with your app. If these settings are missing or incorrect, deep links will open in the browser instead of your app.

4. Install an SDK​

Choose one of the platform guides:

  1. Go to Links → Create Link.
  2. Pick Unified (multi-platform URLs) or Dynamic (deep link parameters).
  3. Follow the platform-specific Getting Started page below to verify deep link behavior:

6. Monitor analytics​

In Links, click the Analytics button for any link to open its analytics page and review clicks, top countries, and sessions for that specific link.
If metrics look off, jump to Troubleshoot & Test Deep Links.