SDK mobiles
Kotlin pour Android/JVM et Swift pour iOS. Des modèles typés et des requêtes asynchrones pour les API géographiques OSRMRoute.
Accès mobile
Enregistrez l’application, configurez la vérification de plateforme et activez l’accès.
Les applications partagent le quota de leur clé API. Les limites comptent tout son trafic ; l’inscription n’ajoute aucun crédit.
Enregistrer une application →- Enregistrer la plateforme et l’identité
- Connecter le fournisseur et vérifier un appareil réel
- Ajouter le SDK, activer l’accès et envoyer une requête
Les SDK Kotlin et Swift 0.2.0 incluent Mobile Access. Installez le paquet stable, configurez la vérification de plateforme et utilisez votre identifiant public d’application.
Android · Play Integrity
Enregistrez votre application dans Google Play et associez son projet Cloud à Play Integrity. Contactez le support avec l’App ID OSRMRoute public, le nom du package et le numéro du projet Cloud. Nous organiserons séparément le transfert privé des identifiants et confirmerons la connexion. Installez ensuite depuis une piste de test Play, activez l’accès et vérifiez un appareil réel. Ne joignez aucune clé privée au ticket.
SHA-256 du certificat de signature de l’application
Google Play Console → App integrity → App signing key certificate → SHA-256. Collez l’empreinte avec les deux-points ; conversion automatique.
implementation("com.google.android.play:integrity:1.6.0")
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-play-services:1.10.1")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
Copiez le préfixe App ID de 10 caractères depuis Apple Developer. Activez production App Attest dans l’application signée.
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)Alternative : utiliser votre propre backend
Conservez la clé OSRMRoute sur votre serveur. L’application envoie sa session temporaire à votre proxy authentifié. Celui-ci contrôle les endpoints autorisés, les accès et les quotas, puis ajoute la clé OSRMRoute côté serveur. Ne transmettez pas le jeton de l’application à OSRMRoute.
Télécharger et installer
Installez Kotlin 0.2.0 depuis Maven Central et Swift 0.2.0 via son URL GitHub publique dans Xcode ou Swift Package Manager. Les archives ZIP du code source restent disponibles.
dependencyResolutionManagement {
repositories { mavenCentral() }
}dependencies {
implementation("com.osrmroute:osrmroute-kotlin:0.2.0")
}
// AndroidManifest.xml:
// <uses-permission android:name="android.permission.INTERNET" />.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 · Kotlinimport 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 · Swiftimport 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].distanceMéthodes disponibles
Réponses typées : route, matrix, geocode, reverse et autocomplete. Places renvoie du JSON. getJson/getJSON et postJson/postJSON couvrent les autres endpoints géographiques. Les limites du forfait et la couverture restent applicables.
Requêtes et erreurs
Aucune répétition par défaut. Jusqu’à deux tentatives facultatives pour les réponses GET 429, 502, 503 ou 504. Pas de répétition si Retry-After dépasse 30 secondes ou contient une date. Les erreurs réseau et POST ne sont jamais répétés automatiquement.
// 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.Intégration API uniquement
Ces paquets ne proposent ni rendu de carte, ni cartes hors ligne, ni navigation guidée. Kotlin : Android API 21+ et JVM 17 ; Swift : iOS 15+ et macOS 12+. Les tests de paquets ne remplacent pas les tests sur appareil.
Documentation →