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.

In Configuration → General, add:

  • iOS URL scheme (e.g. myapp://)
  • Android scheme / host
  • Any store URLs used as fallback destinations

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.