Інтеграція для розробників
Інтеграція для розробників
Інтегруйте Bot Connector у свій застосунок або сайт за допомогою схеми deep-link botconnector://.
URL-схема
Bot Connector реєструє власну URL-схему botconnector:// на iOS. Будь-який застосунок або веб-сторінка може відкрити програму або запустити потрібний сценарій за допомогою цієї схеми.
botconnector://[v1]/[action]?[params]Додати підписку
Найпоширеніша інтеграція — відкрити Bot Connector і запропонувати користувачу додати URL підписки.
botconnector://add-subscription?url={url}&name={name}&autoConnect={true|false}| Parameter | Description |
|---|---|
url | Обов'язковий. URL підписки для імпорту (URL-encoded). |
name | Необов'язковий. Відображувана назва підписки. |
autoConnect | Необов'язковий. Передайте true, щоб підключитися одразу після імпорту. |
JavaScript
jsif (await tryOpen('botconnector://add-subscription?url=' + encodeURIComponent(subUrl))) {
return // app opened
}
window.location.href = 'https://apps.apple.com/app/id${APP_STORE_ID}'Python
pyimport urllib.parse
url = "botconnector://add-subscription?url=" + urllib.parse.quote(sub_url)Bash (macOS)
bashopen "botconnector://add-subscription?url=$(python3 -c 'import urllib.parse,sys; print(urllib.parse.quote(sys.argv[1]))' "$SUB_URL")"Swift
swiftlet encoded = subscriptionURL.addingPercentEncoding(withAllowedCharacters: .urlQueryAllowed)!
let url = URL(string: "botconnector://add-subscription?url=\(encoded)")!
UIApplication.shared.open(url)Відкрити застосунок
Використовуйте botconnector:// (без шляху), щоб просто відкрити застосунок.
Приклад HTML-кнопки
html<a href="botconnector://add-subscription?url=https%3A%2F%2Fexample.com%2Fsub.txt"
style="display:inline-block;padding:.75rem 1.25rem;border-radius:9999px;background:#1E5BFF;color:#fff;text-decoration:none;font-weight:600;">
Open in Bot Connector
</a>Інтеграція через QR-код
Закодуйте botconnector:// URL у QR-код, щоб мобільні користувачі могли імпортувати підписку без набору тексту.
Smart App Banner
Додайте цей мета-тег на свою сторінку, щоб показати Smart App Banner в iOS Safari з посиланням на Bot Connector в App Store.
html<meta name="apple-itunes-app" content="app-id=6767189747, app-argument=botconnector://" />Поведінка при встановленому та невстановленому застосунку
- • Якщо застосунок встановлено, deep-link відкривається миттєво.
- • Якщо застосунок не встановлено, iOS запропонує відкрити App Store. Це можна визначити в JavaScript за допомогою таймауту.
Перевірка встановлення застосунку
Перед викликом deep-link перевірте, чи встановлено Bot Connector.
Universal Links (незабаром)
Версіонування
Версія схеми deep-link кодується у префіксі шляху. Поточна версія: v1. Якщо версія не вказана, за замовчуванням використовується v1.
v1
Тестування
Тестуйте deep-link через адресний рядок Safari на реальному пристрої або в симуляторі iOS.
Що не підтримується
- • Фонове завантаження або тихий push через deep-link.
- • Передача облікових даних (паролів, приватних ключів) через URL-параметри — використовуйте URL підписки.
- • Відкриття Bot Connector з розширення віджета напряму.