Referência da API do SDK

A API do SDK é o que os apps chamam. Ela é separada do painel e usa a chave do SDK de um app, nunca a sua conta.

URL base

https://api.unolink.dev/v1

Autenticação

Crie uma chave no painel, na aba SDK do seu app (plano Pro ou superior), e envie-a em um cabeçalho:

X-Unolink-Key: ulk_…

A chave vai dentro do seu app, então trate-a como pública. Ela só pode consultar e reportar dados do app ao qual pertence, e você pode revogá-la a qualquer momento. Use uma chave por ambiente ou build, para poder revogá-las separadamente. A chave completa é exibida uma única vez, quando você a cria; o Unolink guarda apenas um hash.

Erros

Os erros são problem details em JSON, com um status, um title, um detail e, quando útil, um code estável.

Status	Quando
`401`	A chave está ausente, malformada, é desconhecida ou foi revogada (`code`: `invalid_key`).
`403`	O dono do app não está em um plano que inclui a API do SDK.
`404`	O recurso não existe, ou pertence a outro app.
`429`	Requisições demais de um mesmo endereço IP. Tente de novo mais tarde, com backoff.

GET /v1/clicks/{clickId}

Resolve um ID do clique vindo do referrer de instalação do Google Play para o link dele.

curl https://api.unolink.dev/v1/clicks/clk_01JA9Q3F6Z8W2K4N7R5T1V0X3Y -H "X-Unolink-Key: ulk_…"

{
  "clickId": "clk_01JA9Q3F6Z8W2K4N7R5T1V0X3Y",
  "occurredAt": "2026-10-08T09:41:12.512+00:00",
  "link": { "slug": "tiktok", "name": "TikTok", "isDefault": false },
  "deepLink": "/promo/3for2",
  "params": { "offer": "3for2" },
  "utm": { "source": "tiktok", "medium": "paid", "campaign": "launch", "term": null, "content": "ad7" }
}

link.slug é null para o link principal do app.
deepLink e params são os valores atuais do link, então uma edição feita depois do clique ainda chega ao app.
As tags UTM são as do link em que a pessoa tocou.