Overview

This documentation describes the available options for integrating Kape Services into your ecosystem. The integration stack is organised in three layers, from highest to lowest level:

Integration Layers

┌─────────────────────────────────────┐
│           Platform SDKs             │  iOS · Android  (coming soon)
│  Native wrappers — idiomatic APIs   │
└──────────────┬──────────────────────┘
               │ built on top of
┌──────────────▼──────────────────────┐
│          Low Level SDK              │  Rust core with language bindings
│  Auth · Caching · API abstraction   │  Swift · Kotlin · Go · C# · C/C++
└──────────────┬──────────────────────┘
               │ calls
┌──────────────▼──────────────────────┐
│            REST API                 │  Direct HTTP — maximum flexibility,
│  Raw Kape API endpoints             │  manual auth & caching required
└─────────────────────────────────────┘

Platform SDKs

Platform SDKs are idiomatic, platform-native wrappers built on top of the Low Level SDK. They expose only the APIs relevant to their target platform, apply platform conventions, and handle lifecycle concerns such as background refresh and OS-level credential storage.

Platform SDKs are currently in development. View placeholder documentation →

Low Level SDK

The Low Level SDK is the recommended integration path today. It is implemented in Rust and ships with language bindings for Swift, Kotlin, Go, C#, C/C++, and Rust. It manages authentication, token handling, API caching, server discovery, and more.

circle-info

The Low Level SDK does not provide VPN connection functionality.

Features include:

  • Authorization & authentication management (token handling)

  • Server location, instance, and protocol configuration management

  • Smart Locations

  • Speed testing

  • Client-side protocol pecking

  • Identity protection

  • eSIM support

  • Subscription & in-app purchase handling

Get started with the Low Level SDK →

REST API

For environments where the SDK cannot be used, direct integration with the Kape REST API is available. This approach provides maximum flexibility but requires you to implement authentication, caching, and error handling yourself.

Explore the REST API →

Last updated