Getting Started (Quickstart)

This guide walks you through setting up Detour for your app and integrating the React Native SDK.

1. Create an account

Detour is multi-tenant. An Organization groups apps, links and users and has a unique subdomain:

When creating an organization you choose a unique subdomain: yourorg.godetour.link.
Members invited to the organization can manage apps and links according to their role (owner / admin / member).

The organization subdomain is the base for all generated deferred links.

Under the organization, create an App record for each mobile app you manage:

Android:
- Package name (e.g. com.example.app)
- Signing certificates - SHA 265 (production and debug)
iOS:
- Bundle ID (e.g. com.example.app) — can be found in Xcode, on App Store Connect, or in configuration files.
- Team ID — can be found in Xcode or on the Apple Developer website.
- App Store ID (sometimes called the Apple ID) - can be found in your app's URL on the App Store or on App Store Connect.

Upon app creation you will get:

The App ID and API Key are required by the SDK to call Detour's match endpoint.

In the Links section:

Choose redirect url for web browsers.
Save — the link becomes https://<yourorg>.godetour.link/<your-app-name>.
You can extend your link with additional path segments or search params. For example, https://<yourorg>.godetour.link/<your-app-name>/path/to/page?param=value. It totally depends on what you want achieve.

Install the React Native SDK (detailed in the SDK Installation doc) and set API_KEY + appID in the provider. Then handle navigation in your app.

Click the link on a real device, go to the store, install, and open the app.
The SDK will automatically call the match API and — if matched — returns the route in useDetourContext.

See the SDK usage and Testing & Troubleshooting page for platform-specific test instructions.