Native Android SDK Integration | Quick Start Guide
Overview
The Spyne Automobile Android SDK allows clients to integrate Catalog Shoot and Video Shoot features into their own applications. The SDK supports the shooting experience for:
- Catalog Shoot: Capturing Exterior Images, Capturing 360 Images with Ricoh Theta, Interior Images, and Miscellaneous Images.
- Video Shoot: Capturing Exterior Video, Capturing 360 Images with Ricoh Theta, Interior Images, and Miscellaneous Images.
Note: Currently, exterior Spin-360 can only be generated via video.
Pre-Requisites
Before integrating the SDK, ensure the following:
Development Environment:
- Minimum SDK Version: 26
- Please Note that this should be the minimum version the SDK
- Target & Compile SDK Version: 34
- Minimum Deployment Android Version: 10
Spyne Requirements:
- API Key - Will be provided by your dedicated account manager from Spyne once your account is ready to be integrated with our SDK.
Install Spyne Automobile SDK
To use the Spyne Android SDK, please follow the steps required below:
Step 1: Install using Android Studio and Gradle
Add the Jitpack repository to your project-level build.gradle file at the end of repository
allprojects {
repositories {
google()
mavenCentral()
maven {
url "https://jitpack.io"
credentials { username authToken }
}
}
}
Step 2: Authenticating the SDK
Add the token to your module-level gradle.properties file
authToken = jp_g1e1t35osldunpv5a8u4dcjovr
Step 3: Adding SDK dependency version
Add the dependency to your module-level build.gradle file. spyne_sdk_version the latest sdk version as shared with you by the Spyne team.
dependencies {
implementation 'com.github.Spyne-Tech:spyne-android-sdk:spyne_sdk_version'
}
Latest dependency: implementation 'com.github.Spyne-Tech:spyne-android-sdk:3.0.3'
Step 4: Initializing the SDK
Initialise the client in your Application sub-class.
Note: Please reach out to the Spyne Team for generating an API Key.
public class SampleApp extends Application {
private static final String API_KEY = "API_KEY"
private static final String CATEGORY_ID = "cat_d8R14zUNE"
@Override
public void onCreate() {
Spyne.init(context:this, API_KEY, CATEGORY_ID
}
}
Params and Their Use Cases
Parameter | Description |
---|---|
uniqueUserId | Unique identifier for the user(Email) |
uniqueShootId | VIN number or another unique identifier |
angle | Number of images to capture in Catalog Shoot |
spyneSkuId | SKU ID for adding/replacing images or reshoot |
addReplace | Boolean flag for adding/replacing images |
isReshoot | Boolean flag for QC reshoot |
This document provides a structured approach to integrating the Spyne Android SDK for capturing images and videos. Ensure all dependencies and permissions are configured correctly before proceeding with integration.
Updated 16 days ago