SDK Integration Guide

Eynora LMS SDK

The Eynora LMS SDK enables any Android application to embed the full LMS experience — courses, chapters, live classes, assignments, and video playback — through a simple integration. Branding, API base URL, and theme are resolved automatically from the tenant validation API at runtime using your clientKey.

Table of Contents

• Overview
• Android Integration
  • Requirements
  • Installation
  • Configuration
  • Launching the SDK
  • Authentication Flow
  • Error Handling
• Configuration Reference
• Test Credentials

Overview

The SDK handles the full LMS lifecycle internally:

1. The host app supplies tenant credentials and student details via LmsSdkConfig
2. The SDK initialises its internal dependency graph
3. Brand color, logo, base URL, and theme are fetched from the tenant validation API using clientKey
4. The SDK performs a server-side SDK Login using the student's mobile number — no OTP or password required
5. The full LMS home screen is presented to the student

Note: Branding and API configuration are managed server-side per tenant. The host app only needs to provide TenantDetail and StudentDetail.

Android Integration

Requirements

Installation

Step 1 — Add your GitLab token to Gradle properties

In ~/.gradle/gradle.properties (create the file if it doesn't exist):

gitlabToken=YOUR_GITLAB_PERSONAL_ACCESS_TOKEN

Create a Personal Access Token at https://gitlab.eynora.tech/-/user_settings/personal_access_tokens with the api scope. This file is on your local machine only — never commit it to git.

Step 2 — Add the GitLab Maven registry to your repositories

In settings.gradle.kts:

dependencyResolutionManagement {    repositories {        maven {            url = uri("https://gitlab.eynora.tech/api/v4/projects/4/packages/maven")            credentials(HttpHeaderCredentials::class) {                name = "Private-Token"                value = providers.gradleProperty("gitlabToken").get()            }            authentication {                create<HttpHeaderAuthentication>("header")            }        }        google()        mavenCentral()    }}

Step 3 — Add the dependency

In your app-level build.gradle.kts:

dependencies {    implementation("com.dn:lms-sdk:1.0.0")    coreLibraryDesugaring("com.android.tools:desugar_jdk_libs:2.1.5")}android {    compileOptions {        isCoreLibraryDesugaringEnabled = true        sourceCompatibility = JavaVersion.VERSION_11        targetCompatibility = JavaVersion.VERSION_11    }}

Step 4 — Register the SDK Activity

In AndroidManifest.xml, inside <application>:

<activity    android:name="com.dn.lmssdk.android.LmsSdkActivity"    android:exported="false"    android:theme="@style/Theme.AppCompat.NoActionBar"    tools:replace="android:theme" />

Important: tools:replace="android:theme" is required to prevent manifest merge conflicts with the host app's default theme.

Configuration

Create an LmsSdkConfig with your tenant and student details. The recommended place is your Application subclass:

MyApplication.kt

import android.app.Applicationimport com.dn.lmssdk.LmsSdkimport com.dn.lmssdk.LmsSdkConfigimport com.dn.lmssdk.TenantDetailimport com.dn.lmssdk.StudentDetailclass MyApplication : Application() {    override fun onCreate() {        super.onCreate()        LmsSdk.configure(            LmsSdkConfig(                tenantDetail = TenantDetail(                    tenantId  = "YOUR_TENANT_ID",                    clientKey = "YOUR_CLIENT_KEY"                ),                studentDetail = StudentDetail(                    name      = "Student Name",                    mobileNo  = "9800000000",                    username  = "student.username",                    gradeCode = "GRADE_10"                )            )        )    }}

Register it in AndroidManifest.xml:

<application    android:name=".MyApplication"    ... >

Launching the SDK

After configuring, launch the LMS from any Activity:

import com.dn.lmssdk.android.LmsSdkActivityLmsSdkActivity.launch(this)

The full LMS opens as a new full-screen activity.

Authentication Flow

Host App   │   ├── LmsSdk.configure(config)        ← call once in Application.onCreate()   │   └── LmsSdkActivity.launch(context)  ← call on button tap          │          ├── 1. Koin DI graph initialised          ├── 2. Tenant validation API called → brand, logo, base URL resolved          ├── 3. SDK Login called with studentDetail.mobileNo          │       └── Server issues JWT (no OTP required)          └── 4. LMS Home screen presented

Error Handling

Configuration Reference

LmsSdkConfig

TenantDetail

StudentDetail

Test Credentials

Use the following credentials to test the integration against the staging environment.

Contact the Eynora team at dev@eynora.tech to obtain staging credentials for your integration.