What the SDK Is
The ELERTS SDK lets you embed ELERTS See Say reporting and messaging capabilities directly into your own mobile applications. Rather than deploying a separate ELERTS app, your users can submit reports, receive alerts, and communicate with your operations center from inside the app they already use.
The SDK is available for both major mobile platforms:
| Platform | SDK | Delivered As |
|---|---|---|
| iOS | ELERTSKit | Pre-compiled frameworks |
| Android | ELERTS SDK | Pre-compiled Android library |
Both SDKs are distributed as versioned, pre-compiled binaries — you integrate them as a dependency; no ELERTS source code is required to build your app.
iOS SDK components
ELERTSKit is delivered as two frameworks so you can choose your level of integration:
- ELERTSKitCore — the core SDK: session management, report submission, and messaging APIs. Use this alone if you're building a fully custom user interface.
- ELERTSKitUI — optional, ready-made UI components built on top of the core SDK, for teams that want a faster path to a working integration.
The Android SDK provides the same core capabilities.
How We Distribute the SDK
All ELERTS SDKs are hosted in private GitHub repositories owned and maintained by ELERTS. Distribution is per customer: your organization is granted access to the repositories, and from there the SDK integrates through each platform's standard dependency tooling.
- iOS — the SDK is consumed directly from the private repository using either Swift Package Manager (Apple's native dependency manager, recommended) or CocoaPods. Your developers add the ELERTS repository as a dependency in their project, and Xcode or CocoaPods handles downloading the frameworks.
- Android — the SDK is published to GitHub Packages, GitHub's Maven-compatible package registry. Your developers add the ELERTS package repository to their Gradle configuration and reference the SDK like any other Maven dependency.
Getting Access
Because the repositories are private, access is granted per organization:
- Tell us who needs access. Provide ELERTS with the GitHub usernames (or GitHub organization) of the developers who will integrate the SDK.
- Accept the invitation. Each developer receives a GitHub invitation granting read access to the repositories.
- Authenticate. Developers and build systems authenticate with GitHub using their own credentials or a Personal Access Token. For automated build systems, we recommend a dedicated machine account.
Once access is granted, your team can pull the SDK, receive updates, and browse release notes directly on GitHub.
Versioning & Updates
- Releases follow semantic versioning (
MAJOR.MINOR.PATCH); breaking API changes only occur in major releases. - Each release is tagged in GitHub with release notes covering new features, fixes, and any migration guidance.
- You control when you upgrade — pin to a specific version in production and adopt new releases on your own schedule.
Support
Detailed integration instructions are provided with the SDK repositories. If you have questions about access, distribution, or integration, contact ELERTS support and we'll help you get set up.