Developer guide / v1
Create and verify a mobile link.
Configure a domain, create a route, and test its destination. Examples below match current control-plane and SDK contracts.
/01
Prepare your account
Configure these resources in the target environment before you create a link.
- 01Connect a domain
- 02Register each mobile app
- 03Issue an SDK key
Keep staging and production keys separate. Register distinct app identities in each environment.
/02
Create a link
Run this request from an authenticated control-plane session. Workspace and environment boundaries isolate routing rules and analytics.
typescript
await fetch("https://your-domain.com/api/v1/admin/links", {
method: "POST",
headers: { "content-type": "application/json" },
credentials: "include",
body: JSON.stringify({
domainId: "domain_prod",
slug: "summer",
url: "https://example.com/offers/summer",
}),
});/03
Resolve a link
Resolve a short link from a trusted backend or SDK client. Send the SDK App ID and full short-link URL.
typescript
const response = await fetch(
"https://your-domain.com/api/v1/sdk/short-link/resolve",
{
method: "POST",
headers: {
authorization: "Bearer " + process.env.LINKFORGE_API_KEY,
"content-type": "application/json",
},
body: JSON.stringify({
appID: "app_abc123",
url: "https://go.example.com/summer",
}),
},
);
const { processed, link } = await response.json();
if (processed && link) {
// Continue with the resolved link payload.
}- The API key authorizes one environment and SDK App ID.
- An unmatched link returns HTTP 200 with link set to null.
- Treat processed and link as the resolution outcome.
/04
Verify your domain
Point your hostname to LocusVia. Add the identifiers and signing fingerprints for each registered app.
LocusVia serves both association files from your hostname.
/.well-known/apple-app-site-associationiOS/.well-known/assetlinks.jsonAndroidFetch both files and inspect their contents. Then test each link type on a signed device build.