Ksign App URL Scheme Documentation

Note: This documentation covers how to interact with the Ksign app using the custom URL scheme. You can use these URLs to add sources or install apps directly.

URL Scheme: Ksign://

Ksign supports a custom URL scheme that allows other apps and websites to communicate with it. The app can handle two primary functions through URL schemes:

1. Adding Sources

You can add sources to Ksign using the following format:

Ksign://source/https://your-source-url.com/source.json

Example:

Ksign://source/https://example.com/app.json

Test it now:

Add Example Source

2. Installing Apps

You can trigger app installation directly using the following format:

Ksign://install/https://your-app-download-url.com/app.ipa

Example:

Ksign://install/https://example.com/path/to/app.ipa

Test it now:

Install Example App

Source JSON Structure

When adding a source to Ksign, the app expects the source to provide a JSON file with the following structure:

{
  "name": "Your Repository Name",
  "identifier": "org.your-unique-identifier",
  "sourceURL": "https://yourdomain.com/app.json",
  "iconURL": "https://yourdomain.com/logo.jpg",
  "website": "https://yourdomain.com",
  "subtitle": "Your repository description",
  "META": {
    "repoName": "Your Repository Name",
    "repoIcon": "https://yourdomain.com/logo.jpg"
  },
  "apps": [
    {
      "name": "App Name",
      "type": 1,
      "bundleID": "com.example.appidentifier",
      "bundleIdentifier": "com.example.appidentifier",
      "version": "1.0.0",
      "versionDate": "2024-09-27",
      "fullDate": "20240927123456",
      "size": 12345678,
      "down": "https://example.com/path/to/yourfile.ipa",
      "downloadURL": "https://example.com/path/to/yourfile.ipa",
      "developerName": "Developer Name",
      "localizedDescription": "App description goes here",
      "icon": "data:image/png;base64,...",
      "iconURL": "data:image/png;base64,..."
    }
  ]
}

Field Descriptions

Field Description
name The name of your repository
identifier A unique identifier for your repository
sourceURL URL pointing to this JSON file
iconURL URL to your repository's icon image
website Your website URL
subtitle A short description of your repository
apps An array of app objects

App Object Fields

Field Description
name The name of the app
type App type (1 for iOS apps)
bundleID/bundleIdentifier The app's bundle identifier
version App version string
versionDate Release date in YYYY-MM-DD format
fullDate Timestamp in YYYYMMDDhhmmss format
size File size in bytes
down/downloadURL Direct download URL for the IPA file
localizedDescription Description of the app
icon/iconURL Base64 encoded image data or URL to app icon

Creating Your Own Source

To create your own source for the Ksign app:

  1. Create a JSON file following the structure above
  2. Host the JSON file on a web server with HTTPS
  3. Make sure any IPA files referenced are also hosted on HTTPS URLs
  4. Test your source by creating a link with the format: Ksign://source/https://your-source-url.com/source.json

Security Notes

Important: Ksign only supports HTTPS URLs for security reasons. Both source URLs and download URLs must use HTTPS.

Example Implementation

If you're creating a webpage with links to add your source to Ksign, you can use code like this:

<a href="Ksign://source/https://yourdomain.com/app.json">
  Add to Ksign
</a>

Or to directly install an app:

<a href="Ksign://install/https://yourdomain.com/app.ipa">
  Install with Ksign
</a>