Skip to main content

SDK Installation & Setup

Getting Started with the SDK

Step 1 — Get your API key

  1. Sign up for an Orbitly developer account at orbitlyapp.com/developers
  2. Create a new project in the developer portal
  3. Copy your API key from the project settings

Step 2 — Add the dependency

Add the Orbitly SDK to your app-level build.gradle:

dependencies {
    implementation 'com.orbitly:sdk:1.x.x'
}

Add the Orbitly Maven repository to your project-level build.gradle or settings.gradle:

repositories {
    maven { url 'https://maven.orbitlyapp.com/releases' }
}

Step 3 — Initialize the SDK

In your Application class or main Activity:

import com.orbitly.sdk.Orbitly;

public class MyApp extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        Orbitly.init(this, "YOUR_API_KEY");
    }
}

Step 4 — Sync Gradle

Sync your Gradle files and build the project. The SDK is now ready to use.