REST API

Applications

Applications: 7 endpoints of the REST API.

GET/apps

Get the apps of an environment

Every platform that is configured (null for the others), the environment-wide validation report and the Flutter setup snippets.

Secret key scope (any of): apps:write

Responses

200 The apps.

Field	Type	Description
`environment`required	`"test" \| "live"`
`link_hosts`required	`string[]`	Hosts the app opens links on; they go into the entitlement and the manifest.
`ios`required	`object \| null`	Null until configured.
`android`required	`object \| null`	Null until configured.
`web`required	`object \| null`	Null until configured.
`issues`required	`object[]`	Validation report: `error` blocks publishing the live environment, `warning` is saved but links may not work as expected.
`issues[].level`required	`"error" \| "warning"`
`issues[].code`required	`"ios_app_store_id_required" \| "ios_min_os_version_unsupported" \| "ios_path_pattern_matches_no_link" \| "android_single_fingerprint" \| "android_play_signing_key_missing" \| "android_debug_key_in_live"`
`issues[].platform`required	`"ios" \| "android" \| "web"`
`issues[].field`required	`string \| null`
`issues[].message`required	`string`
`issues[].help_url`required	`string \| null`
`flutter`required	`object`
`flutter.pubspec`required	`string`	`dependencies:` entry for pubspec.yaml.
`flutter.dart_init`required	`string`	`lib/main.dart` start-up. Shows `YOUR_PUBLISHABLE_KEY` until the environment has a publishable key.

Example

Bash

curl -X GET "https://api.becklinks.com/v1/apps" \
  -H "Authorization: Bearer $SECRET_KEY"

GET/apps/android

Get the Android app

Secret key scope (any of): apps:write

Responses

200 The Android app.

Field	Type	Description
`application`required	`object`
`application.environment`required	`"test" \| "live"`
`application.package_name`required	`string`
`application.play_store_url`required	`string \| null`
`application.custom_scheme`required	`string \| null`
`application.fingerprints`required	`object[]`
`application.fingerprints[].sha256`required	`string`	Uppercase, colon-separated.
`application.fingerprints[].label`required	`"play_signing" \| "upload" \| "debug" \| null`
`application.app_name`required	`string \| null`	Store listing name, filled in by the metadata worker; null until then.
`application.icon_url`required	`string \| null`	Store listing icon, same source.
`application.created_at`required	`string (date-time)`
`application.updated_at`required	`string (date-time)`
`issues`required	`object[]`	Validation report: `error` blocks publishing the live environment, `warning` is saved but links may not work as expected.
`issues[].level`required	`"error" \| "warning"`
`issues[].code`required	`"ios_app_store_id_required" \| "ios_min_os_version_unsupported" \| "ios_path_pattern_matches_no_link" \| "android_single_fingerprint" \| "android_play_signing_key_missing" \| "android_debug_key_in_live"`
`issues[].platform`required	`"ios" \| "android" \| "web"`
`issues[].field`required	`string \| null`
`issues[].message`required	`string`
`issues[].help_url`required	`string \| null`
`outputs`required	`object`
`outputs.assetlinks`required	`object[]`	Preview of `/.well-known/assetlinks.json` as every link host serves it.
`outputs.assetlinks[].relation`required	`string[]`
`outputs.assetlinks[].target`required	`object`
`outputs.assetlinks[].target.namespace`required	`"android_app"`
`outputs.assetlinks[].target.package_name`required	`string`
`outputs.assetlinks[].target.sha256_cert_fingerprints`required	`string[]`
`outputs.android_manifest`required	`string`	Elements for the MainActivity `<activity>` in AndroidManifest.xml.
`outputs.flutter`required	`object`
`outputs.flutter.pubspec`required	`string`	`dependencies:` entry for pubspec.yaml.
`outputs.flutter.dart_init`required	`string`	`lib/main.dart` start-up. Shows `YOUR_PUBLISHABLE_KEY` until the environment has a publishable key.

Example

Bash

curl -X GET "https://api.becklinks.com/v1/apps/android" \
  -H "Authorization: Bearer $SECRET_KEY"

PUT/apps/android

Set the Android app

Creates or replaces the Android app of this environment: package name, 1 to 20 SHA-256 signing certificate fingerprints (any letter case, normalized to AA:BB:…) and an optional Play Store URL. The response carries the validation report (issues) and the generated files to copy into the app.

Secret key scope (any of): apps:write

Request body

Field	Type	Description
`package_name`required	`string`
`play_store_url`	`string \| null`
`custom_scheme`	`string \| null`
`fingerprints`required	`object[]`
`fingerprints[].sha256`required	`string`
`fingerprints[].label`	`"play_signing" \| "upload" \| "debug" \| null`

Responses

200 The saved Android app.

Field	Type	Description
`application`required	`object`
`application.environment`required	`"test" \| "live"`
`application.package_name`required	`string`
`application.play_store_url`required	`string \| null`
`application.custom_scheme`required	`string \| null`
`application.fingerprints`required	`object[]`
`application.fingerprints[].sha256`required	`string`	Uppercase, colon-separated.
`application.fingerprints[].label`required	`"play_signing" \| "upload" \| "debug" \| null`
`application.app_name`required	`string \| null`	Store listing name, filled in by the metadata worker; null until then.
`application.icon_url`required	`string \| null`	Store listing icon, same source.
`application.created_at`required	`string (date-time)`
`application.updated_at`required	`string (date-time)`
`issues`required	`object[]`	Validation report: `error` blocks publishing the live environment, `warning` is saved but links may not work as expected.
`issues[].level`required	`"error" \| "warning"`
`issues[].code`required	`"ios_app_store_id_required" \| "ios_min_os_version_unsupported" \| "ios_path_pattern_matches_no_link" \| "android_single_fingerprint" \| "android_play_signing_key_missing" \| "android_debug_key_in_live"`
`issues[].platform`required	`"ios" \| "android" \| "web"`
`issues[].field`required	`string \| null`
`issues[].message`required	`string`
`issues[].help_url`required	`string \| null`
`outputs`required	`object`
`outputs.assetlinks`required	`object[]`	Preview of `/.well-known/assetlinks.json` as every link host serves it.
`outputs.assetlinks[].relation`required	`string[]`
`outputs.assetlinks[].target`required	`object`
`outputs.assetlinks[].target.namespace`required	`"android_app"`
`outputs.assetlinks[].target.package_name`required	`string`
`outputs.assetlinks[].target.sha256_cert_fingerprints`required	`string[]`
`outputs.android_manifest`required	`string`	Elements for the MainActivity `<activity>` in AndroidManifest.xml.
`outputs.flutter`required	`object`
`outputs.flutter.pubspec`required	`string`	`dependencies:` entry for pubspec.yaml.
`outputs.flutter.dart_init`required	`string`	`lib/main.dart` start-up. Shows `YOUR_PUBLISHABLE_KEY` until the environment has a publishable key.

Example

Bash

curl -X PUT "https://api.becklinks.com/v1/apps/android" \
  -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"package_name":"string","fingerprints":[{"sha256":"string"}]}'

GET/apps/ios

Get the iOS app

Secret key scope (any of): apps:write

Responses

200 The iOS app.

Field	Type	Description
`application`required	`object`
`application.environment`required	`"test" \| "live"`
`application.bundle_id`required	`string`
`application.apple_team_id`required	`string`
`application.app_store_id`required	`string \| null`
`application.min_os_version`required	`string \| null`
`application.allowed_path_patterns`required	`string[] \| null`
`application.custom_scheme`required	`string \| null`
`application.app_name`required	`string \| null`	Store listing name, filled in by the metadata worker; null until then.
`application.icon_url`required	`string \| null`	Store listing icon, same source.
`application.created_at`required	`string (date-time)`
`application.updated_at`required	`string (date-time)`
`issues`required	`object[]`	Validation report: `error` blocks publishing the live environment, `warning` is saved but links may not work as expected.
`issues[].level`required	`"error" \| "warning"`
`issues[].code`required	`"ios_app_store_id_required" \| "ios_min_os_version_unsupported" \| "ios_path_pattern_matches_no_link" \| "android_single_fingerprint" \| "android_play_signing_key_missing" \| "android_debug_key_in_live"`
`issues[].platform`required	`"ios" \| "android" \| "web"`
`issues[].field`required	`string \| null`
`issues[].message`required	`string`
`issues[].help_url`required	`string \| null`
`outputs`required	`object`
`outputs.aasa`required	`object`	Preview of `/.well-known/apple-app-site-association` as every link host of the environment serves it.
`outputs.aasa.applinks`required	`object`
`outputs.aasa.applinks.details`required	`object[]`
`outputs.aasa.applinks.details[].appIDs`required	`string[]`
`outputs.aasa.applinks.details[].components`required	`object[]`
`outputs.xcode_entitlements`required	`string`	`Runner.entitlements` file contents.
`outputs.info_plist`required	`string`	Keys to add to `Info.plist`.
`outputs.flutter`required	`object`
`outputs.flutter.pubspec`required	`string`	`dependencies:` entry for pubspec.yaml.
`outputs.flutter.dart_init`required	`string`	`lib/main.dart` start-up. Shows `YOUR_PUBLISHABLE_KEY` until the environment has a publishable key.

Example

Bash

curl -X GET "https://api.becklinks.com/v1/apps/ios" \
  -H "Authorization: Bearer $SECRET_KEY"

PUT/apps/ios

Set the iOS app

Creates or replaces the iOS app of this environment: bundle ID, Apple Team ID, App Store ID and the path patterns the app opens. The App Store ID is optional in test and required in live (422 otherwise). The response carries the validation report (issues) and the generated files to copy into the app.

Secret key scope (any of): apps:write

Request body

Field	Type	Description
`bundle_id`required	`string`
`apple_team_id`required	`string`
`app_store_id`	`string \| null`
`min_os_version`	`string \| null`
`allowed_path_patterns`	`string[] \| null`
`custom_scheme`	`string \| null`

Responses

200 The saved iOS app.

Field	Type	Description
`application`required	`object`
`application.environment`required	`"test" \| "live"`
`application.bundle_id`required	`string`
`application.apple_team_id`required	`string`
`application.app_store_id`required	`string \| null`
`application.min_os_version`required	`string \| null`
`application.allowed_path_patterns`required	`string[] \| null`
`application.custom_scheme`required	`string \| null`
`application.app_name`required	`string \| null`	Store listing name, filled in by the metadata worker; null until then.
`application.icon_url`required	`string \| null`	Store listing icon, same source.
`application.created_at`required	`string (date-time)`
`application.updated_at`required	`string (date-time)`
`issues`required	`object[]`	Validation report: `error` blocks publishing the live environment, `warning` is saved but links may not work as expected.
`issues[].level`required	`"error" \| "warning"`
`issues[].code`required	`"ios_app_store_id_required" \| "ios_min_os_version_unsupported" \| "ios_path_pattern_matches_no_link" \| "android_single_fingerprint" \| "android_play_signing_key_missing" \| "android_debug_key_in_live"`
`issues[].platform`required	`"ios" \| "android" \| "web"`
`issues[].field`required	`string \| null`
`issues[].message`required	`string`
`issues[].help_url`required	`string \| null`
`outputs`required	`object`
`outputs.aasa`required	`object`	Preview of `/.well-known/apple-app-site-association` as every link host of the environment serves it.
`outputs.aasa.applinks`required	`object`
`outputs.aasa.applinks.details`required	`object[]`
`outputs.aasa.applinks.details[].appIDs`required	`string[]`
`outputs.aasa.applinks.details[].components`required	`object[]`
`outputs.xcode_entitlements`required	`string`	`Runner.entitlements` file contents.
`outputs.info_plist`required	`string`	Keys to add to `Info.plist`.
`outputs.flutter`required	`object`
`outputs.flutter.pubspec`required	`string`	`dependencies:` entry for pubspec.yaml.
`outputs.flutter.dart_init`required	`string`	`lib/main.dart` start-up. Shows `YOUR_PUBLISHABLE_KEY` until the environment has a publishable key.

Example

Bash

curl -X PUT "https://api.becklinks.com/v1/apps/ios" \
  -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"bundle_id":"string","apple_team_id":"string"}'

GET/apps/web

Get the web defaults

Secret key scope (any of): apps:write

Responses

200 The web defaults.

Field	Type	Description
`application`required	`object`
`application.environment`required	`"test" \| "live"`
`application.website_url`required	`string`
`application.fallback_url`required	`string \| null`
`application.desktop_behavior`required	`"web_page" \| "qr_handoff" \| "store_page"`
`application.created_at`required	`string (date-time)`
`application.updated_at`required	`string (date-time)`
`issues`required	`object[]`	Validation report: `error` blocks publishing the live environment, `warning` is saved but links may not work as expected.
`issues[].level`required	`"error" \| "warning"`
`issues[].code`required	`"ios_app_store_id_required" \| "ios_min_os_version_unsupported" \| "ios_path_pattern_matches_no_link" \| "android_single_fingerprint" \| "android_play_signing_key_missing" \| "android_debug_key_in_live"`
`issues[].platform`required	`"ios" \| "android" \| "web"`
`issues[].field`required	`string \| null`
`issues[].message`required	`string`
`issues[].help_url`required	`string \| null`

Example

Bash

curl -X GET "https://api.becklinks.com/v1/apps/web" \
  -H "Authorization: Bearer $SECRET_KEY"

PUT/apps/web

Set the web defaults

Creates or replaces the website URL, the fallback URL (defaults to the website URL) and what desktop visitors get. Link-level URLs override these.

Secret key scope (any of): apps:write

Request body

Field	Type	Description
`website_url`required	`string`
`fallback_url`	`string \| null`
`desktop_behavior`required	`"web_page" \| "qr_handoff" \| "store_page"`

Responses

200 The saved web defaults.

Field	Type	Description
`application`required	`object`
`application.environment`required	`"test" \| "live"`
`application.website_url`required	`string`
`application.fallback_url`required	`string \| null`
`application.desktop_behavior`required	`"web_page" \| "qr_handoff" \| "store_page"`
`application.created_at`required	`string (date-time)`
`application.updated_at`required	`string (date-time)`
`issues`required	`object[]`	Validation report: `error` blocks publishing the live environment, `warning` is saved but links may not work as expected.
`issues[].level`required	`"error" \| "warning"`
`issues[].code`required	`"ios_app_store_id_required" \| "ios_min_os_version_unsupported" \| "ios_path_pattern_matches_no_link" \| "android_single_fingerprint" \| "android_play_signing_key_missing" \| "android_debug_key_in_live"`
`issues[].platform`required	`"ios" \| "android" \| "web"`
`issues[].field`required	`string \| null`
`issues[].message`required	`string`
`issues[].help_url`required	`string \| null`

Example

Bash

curl -X PUT "https://api.becklinks.com/v1/apps/web" \
  -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"website_url":"string","desktop_behavior":"web_page"}'