Documentation

Welcome to Spare Docs! Here you can learn more about how to integrate the Spare Rider Deep Links and explore some of the Spare Platform features.

Quick Links:

Spare Platform →

Api Reference →

Spare Driver App →


Getting Started

Deep Links allow a rider to perform actions in the Spare Rider app just by tapping a link (currently these actions are limited to launching the app or making an estimate).

To set this up you will need the Spare Rider app (iOS: https://apps.apple.com/us/app/spare-rider/id1414542240, Android: https://play.google.com/store/apps/details?id=com.sparelabs.platform.rider.base) or a whitelabel rider app installed on your device.

If you have any questions, consult the Spare Help Docs (help.sparelabs.com) or contact us!

Link structure

A Deep Link looks like the following:

https://**APP_URL**/?link=**URL_ENCODED_LINK**&ofl=**FALLBACK_URL**&apn=**ANDROID_BUNDLE_ID** &isi=**APP_STORE_ID**&ibi=**IOS_BUNDLE_ID**&utm_source=**ATTRIBUTION_SOURCE**

The parameter values in BOLD_CAPITALS need to be replaced by your application, all parameters are required :