Skip to content

docs: correct setup, config and privacy details in README, API.md and llms.txt - #21

Merged
onamfc merged 1 commit into
mainfrom
docs/readme-accuracy
Oct 28, 2026
Merged

onamfc merged 1 commit into
mainfrom
docs/readme-accuracy

Conversation

@onamfc

@onamfc onamfc commented Oct 27, 2026

Copy link
Copy Markdown
Member

Documentation only: no code, Gradle or version changes. Each fix was checked against the 1.8.0 source (origin/main = v1.8.0).

README

  • Initialize: the sample used a short-link host as baseURL and called appToken "recommended". It now uses the hosted API host (https://api.linkforty.com) and says the hosted service requires appToken. apiKey is dropped from the init sample, because it is a secret needed only by createLink(). Added a field table (LinkFortyConfig.kt: HTTPS rule incl. 0.0.0.0, window 1–2160 h), the retry-on-failure behavior of initialize(), the full imports, and the Maven Central repository.
  • Coroutines: initialize, trackEvent, trackRevenue, trackScreenView and createLink are suspend functions that throw NotInitialized before initialize() finishes. The README now says so.
  • App Links: the manifest sample now has android:exported="true" (required for targetSdk 31+) and launchMode="singleTask", so onNewIntent() fires. setIntent() was added in onNewIntent. The lookup rule now names the baseURL host (LinkDomains.isLinkFortyUrl).
  • assetlinks.json: the file is served by the server, from the app configuration on the hosted service or from ANDROID_PACKAGE_NAME / ANDROID_SHA256_FINGERPRINTS on Core. Builds that use Play App Signing need the app signing key's SHA-256. The "Verify Digital Asset Links" command only opened a link. The test section now uses pm verify-app-links --re-verify / pm get-app-links.
  • createLink: the SDK falls back to POST /api/links on a server without /api/sdk/v1/links. Core's /api/links requires originalUrl, which CreateLinkOptions doesn't send. The old "No API key needed for self-hosted" note is removed, since the SDK throws MissingApiKey without one.
  • Privacy: "No persistent IDs / probabilistic fingerprinting only" no longer matched the code. The SDK sends the Play install referrer for an exact match, and it stores a server-assigned install ID that every event carries. The data list now covers what the install, resolve and event requests send. It also notes the BIND_GET_INSTALL_REFERRER_SERVICE permission that installreferrer 2.2 adds (normal permission, no prompt).
  • Added Flutter to "Other SDKs".

API.md

  • attributionMethod can also be "install_referrer". Updated the appToken / apiKey / baseURL descriptions and the init example.

llms.txt

  • Version 1.1.0 → 1.8.0. Dropped the GitHub Packages repository block: the SDK is published to Maven Central (see RELEASING.md).
  • Fixed the hosted base URL. Replaced "All SDK methods work identically with both" with the real differences (link domains, createLink).
  • initialize() no longer says it must come before any other method: callbacks and handleDeepLink can be called first.

Samples were checked against the source, not compiled.

… llms.txt

- Initialize against the hosted API host (https://api.linkforty.com) with an
  appToken, which the hosted service requires; apiKey is only for createLink()
  and is a secret.
- Add a config field table, the Maven Central repository, and the coroutine
  requirement for initialize() and the tracking calls.
- App Links: android:exported="true" and launchMode="singleTask" in the
  manifest sample, setIntent() in onNewIntent, how assetlinks.json is served,
  the Play App Signing fingerprint, and pm verify-app-links / get-app-links.
- createLink(): against a Core server the fallback POST /api/links needs an
  originalUrl the SDK doesn't send.
- Privacy: replace "probabilistic fingerprinting only / no persistent IDs" with
  what the code does (Play install referrer, stored install ID), list the data
  each request sends and the install referrer permission the dependency adds.
- API.md: attributionMethod can be "install_referrer"; appToken/apiKey wording.
- llms.txt: version 1.1.0 -> 1.8.0, drop the GitHub Packages repository (the
  SDK is on Maven Central), fix the hosted base URL and the claim that all
  methods work identically on a self-hosted server.
@onamfc
onamfc merged commit 7ee8462 into main Oct 28, 2026
13 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants