osrmroute
Документация

Мобильные SDK

Kotlin для Android/JVM и Swift для iOS. Типизированные модели и асинхронные запросы к географическим API OSRMRoute.

Kotlin · AndroidSwift · iOSOSRMRouteAPI

Мобильный доступ

Зарегистрируйте приложение, настройте проверку платформы и включите доступ.

Приложения используют квоту связанного API-ключа. Лимиты учитывают весь его трафик; регистрация не добавляет кредиты.

Регистрация приложения →
  1. Укажите платформу и идентификатор
  2. Подключите провайдера и проверьте реальное устройство
  3. Добавьте SDK, включите доступ и отправьте запрос

Kotlin и Swift SDK 0.2.0 поддерживают Mobile Access. Установите стабильный пакет, настройте проверку платформы и используйте публичный ID приложения.

Android · Play Integrity

Зарегистрируйте приложение в Google Play и свяжите проект Cloud с Play Integrity. Передайте поддержке публичный OSRMRoute App ID, имя пакета и номер проекта Cloud. Передачу секретных учетных данных мы организуем отдельно и подтвердим подключение. Затем установите приложение из тестового канала Play, включите доступ и проверьте реальное устройство. Не прикладывайте секретные ключи к тикету.

SHA-256 сертификата подписи приложения

Google Play Console → App integrity → App signing key certificate → SHA-256. Вставьте отпечаток с двоеточиями; преобразование автоматическое.

Android · app/build.gradle.kts
implementation("com.google.android.play:integrity:1.6.0")
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-play-services:1.10.1")
Kotlin · Play Integrity
import android.content.Context
import android.util.Base64
import com.google.android.play.core.integrity.IntegrityManagerFactory
import com.google.android.play.core.integrity.StandardIntegrityManager
import com.osrmroute.MobileAccess
import com.osrmroute.OSRMRoute
import kotlinx.coroutines.tasks.await
import java.util.UUID

// Call once; reuse the returned pair and close both when no longer needed.
suspend fun makeMapClient(context: Context, cloudProjectNumber: Long): Pair<MobileAccess, OSRMRoute> {
    val appId = "YOUR_PUBLIC_APP_ID"
    val prefs = context.getSharedPreferences("osrmroute.$appId", Context.MODE_PRIVATE)
    val keyId = prefs.getString("installation", null) ?: UUID.randomUUID().toString().also {
        prefs.edit().putString("installation", it).apply()
    }
    val provider = IntegrityManagerFactory.createStandard(context.applicationContext)
        .prepareIntegrityToken(StandardIntegrityManager.PrepareIntegrityTokenRequest.builder()
            .setCloudProjectNumber(cloudProjectNumber).build()).await()
    val access = MobileAccess(appId, keyId) { payload ->
        val hash = Base64.encodeToString(MobileAccess.requestHash(payload),
            Base64.URL_SAFE or Base64.NO_WRAP or Base64.NO_PADDING)
        provider.request(StandardIntegrityManager.StandardIntegrityTokenRequest.builder()
            .setRequestHash(hash).build()).await().token()
    }
    return access to OSRMRoute(baseUrl = "https://osrmroute.com", tokenProvider = { access.token() })
}
// cloudProjectNumber: your Google Cloud project linked to Play Integrity.
// After enabling the app and allowing the geocode scope:
// val (access, client) = makeMapClient(context, yourCloudProjectNumber)
// val result = client.geocode("Berlin", 1)

iOS · App Attest

Скопируйте 10-символьный App ID prefix из Apple Developer. В подписанном приложении включите production App Attest.

Swift · App Attest
import Foundation
import OSRMRoute

// Call once during application setup; retain and reuse the returned client.
@MainActor
func makeMapClient() async throws -> OSRMRouteClient {
    let appID = "YOUR_PUBLIC_APP_ID"
    let storageKey = "osrmroute.attest.\(appID)"
    let keyID: String
    if let saved = UserDefaults.standard.string(forKey: storageKey) {
        keyID = saved
    } else {
        keyID = try await AppleMobileProof.generateKey()
        UserDefaults.standard.set(keyID, forKey: storageKey)
    }
    let access = try MobileAccess(appID: appID, keyID: keyID) { payload, enrolled in
        try await AppleMobileProof.proof(keyID: keyID, payload: payload, enrolled: enrolled)
    }
    return try OSRMRouteClient(baseURL: URL(string: "https://osrmroute.com")!) {
        try await access.token()
    }
}
// After enabling the app and allowing the geocode scope:
// let client = try await makeMapClient()
// let result = try await client.geocode("Berlin", limit: 1)

Альтернатива: собственный сервер

Храните ключ OSRMRoute на сервере. Приложение передаёт краткосрочный токен сессии вашему защищённому прокси. Прокси проверяет разрешённые endpoint, доступ и лимиты пользователя, добавляя ключ OSRMRoute на сервере. Не передавайте токен приложения в OSRMRoute.

Скачать и установить

Установите Kotlin 0.2.0 из Maven Central, а Swift 0.2.0 — по публичному URL GitHub в Xcode или Swift Package Manager. ZIP-архивы исходного кода также доступны.

settings.gradle.kts
dependencyResolutionManagement {
    repositories { mavenCentral() }
}
app/build.gradle.kts
dependencies {
    implementation("com.osrmroute:osrmroute-kotlin:0.2.0")
}
// AndroidManifest.xml:
// <uses-permission android:name="android.permission.INTERNET" />
Xcode · Swift Package Manager
.package(url: "https://github.com/Mammadoff/osrmroute-swift.git", from: "0.2.0")
// Xcode: File > Add Package Dependencies > enter the GitHub URL.
// Add the OSRMRoute library to your application target.

Kotlin · Android / JVM

GitHub · Kotlin
Kotlin
import com.osrmroute.OSRMRoute
import com.osrmroute.Coordinate

// Call from a coroutine. Use your app session, not an embedded OSRMRoute key.
val client = OSRMRoute(
    baseUrl = "https://your-backend.example/location",
    tokenProvider = { applicationSessionToken }
)
val result = client.route(listOf(
    Coordinate(latitude = 52.52, longitude = 13.405),
    Coordinate(latitude = 52.50, longitude = 13.39)
))
val metres = result.routes.first().distance
// Close the shared client when its owner is disposed.
client.close()

Swift · iOS

GitHub · Swift
Swift
import Foundation
import OSRMRoute

// Call from an async function. Use your own authenticated backend.
let client = try OSRMRouteClient(
    baseURL: URL(string: "https://your-backend.example/location")!,
    tokenProvider: { applicationSessionToken }
)
let result = try await client.route([
    Coordinate(latitude: 48.8566, longitude: 2.3522),
    Coordinate(latitude: 48.8606, longitude: 2.3376)
])
let metres = result.routes[0].distance

Методы

Типизированные ответы: route, matrix, geocode, reverse и autocomplete. Places возвращает JSON. getJson/getJSON и postJson/postJSON поддерживают другие географические endpoint. Лимиты тарифа и покрытие сохраняются.

Запросы и ошибки

По умолчанию повторов нет. Можно включить до двух повторов GET при 429, 502, 503 или 504. Retry-After свыше 30 секунд или в формате даты не повторяется. Сетевые ошибки и POST автоматически не повторяются.

Kotlin / Swift
// Kotlin: OSRMRouteException.status and .code
// Swift: SDKError.http(status:), .transport, .invalidResponse, .invalidInput
// Cancellation propagates to the caller.
// Default timeout: 30 seconds. Configurable maximum: 120 seconds.
// Coordinates: latitude, longitude. Distances: metres. Durations: seconds.
// Matrix null cells mean unreachable, not zero.

Только интеграция API

Пакеты не рисуют карты и не предоставляют офлайн-карты или пошаговую навигацию. Kotlin: Android API 21+ и JVM 17; Swift: iOS 15+ и macOS 12+. Тесты пакетов не заменяют проверку на устройствах.

Документация →

Поддержка OSRMRoute

Напишите нашей команде напрямую

МЫ ГОТОВЫ ПОМОЧЬ

Чем вам помочь?

Напишите нам. Ответы на обращения также отправляются на подтверждённую почту.

Ваши чаты

Ваши чаты появятся здесь.