osrmroute
Documentación

SDK móviles

Kotlin para Android/JVM y Swift para iOS. Modelos tipados y solicitudes asíncronas para las API geográficas de OSRMRoute.

Kotlin · AndroidSwift · iOSOSRMRouteAPI

Acceso móvil

Registra la aplicación, configura la verificación de plataforma y activa el acceso.

Las aplicaciones comparten la cuota de su clave API. Los límites incluyen todo su tráfico; registrar una aplicación no añade créditos.

Registrar aplicación →
  1. Registra la plataforma y la identidad
  2. Conecta el proveedor y verifica un dispositivo real
  3. Añade el SDK, activa el acceso y envía una solicitud

Los SDK Kotlin y Swift 0.2.0 incluyen Mobile Access. Instala el paquete estable, configura la verificación de plataforma y usa tu ID público de aplicación.

Android · Play Integrity

Registra tu aplicación en Google Play y vincula su proyecto Cloud con Play Integrity. Contacta con soporte con el App ID público de OSRMRoute, el nombre del paquete y el número del proyecto Cloud. Organizaremos por separado la transferencia privada de credenciales y confirmaremos la conexión. Después instala desde una pista de prueba de Play, activa el acceso y verifica un dispositivo real. No adjuntes claves privadas al ticket.

SHA-256 del certificado de firma de la aplicación

Google Play Console → App integrity → App signing key certificate → SHA-256. Pega la huella con dos puntos; conversión automática.

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

Copia el App ID prefix de 10 caracteres de Apple Developer. Activa production App Attest en la aplicación firmada.

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)

Alternativa: usa tu propio backend

Guarda la clave de OSRMRoute en tu servidor. La aplicación envía su sesión temporal a tu proxy autenticado. El proxy valida endpoints permitidos, acceso y límites e incorpora la clave de OSRMRoute en el servidor. No reenvíes el token de la aplicación a OSRMRoute.

Descarga e instalación

Instala Kotlin 0.2.0 desde Maven Central y Swift 0.2.0 mediante su URL pública de GitHub en Xcode o Swift Package Manager. También puedes descargar el código fuente en 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

Métodos compatibles

Respuestas tipadas: route, matrix, geocode, reverse y autocomplete. Places devuelve JSON. getJson/getJSON y postJson/postJSON admiten otros endpoints geográficos. Se aplican los límites del plan y la cobertura.

Solicitudes y errores

Sin reintentos por defecto. Opcionalmente hasta dos reintentos GET para 429, 502, 503 o 504. No se repite si Retry-After supera 30 segundos o tiene formato de fecha. Los errores de red y las solicitudes POST nunca se reintentan automáticamente.

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.

Solo integración API

No incluye renderizado de mapas, mapas sin conexión ni navegación guiada. Kotlin: Android API 21+ y JVM 17; Swift: iOS 15+ y macOS 12+. Las pruebas del paquete no sustituyen pruebas en dispositivos.

Documentación →

Soporte OSRMRoute

Escriba directamente a nuestro equipo

ESTAMOS PARA AYUDAR

¿Cómo podemos ayudarle?

Envía un mensaje. Las respuestas a los tickets también se envían a tu correo verificado.

Tus chats

Tus chats aparecerán aquí.