Overview

Visit Klefki Keys Dashoboard to get started!

Klefki Keys is a platform that allows developers to monetize their applications on a pay-per-use model, while enabling users to easily discover, onboard, and pay for tools using secure, unique klefki keys.

This documentation contains two sections:

• Developer Documentation – For integrating your app with Klefki.
• User Documentation – For using apps found on the Klefki platform.

Common notes for all users/developers

1. 1 Klefki Credit = 1 INR
2. Klefki Keys is currently in Beta Stage. We are continuously working to improve the platform and add new features.
3. While using the Kleki Keys Platform, if you encounter any unexpected behaviou try to logout -> re-login and try again. Feel free to write us at tfypfilms@gmail.com about any inconvenience! We would love to hear you 🤗
4. Anyone's Klefki Keys are highly confidential and must not be shared with anyone.
5. For any issues, contact the Klefki team at tfypfilms@gmail.com

Developer Documentation

1. Introduction

As a developer, you can monetize your application or service on a usage basis. Klefki handles user credits, payments, logs, and monthly payouts.

2. Getting Started

Step 1: Login

Visit https://klefkikeys.netlify.app/ and log in using your Google account.

Step 2: Create Your App

Navigate to Owned Apps → Create an App and fill the following:

1. Name of the App – users will see this publicly.
2. Status – choose whether the app is Launched or Under Development.
3. Description – add details about your app. It is recommended to include a link to your service/app. If it isn't launched yet and you have a waitlist, add the link to waitlist.
4. Payment Mode – choose how you'd like to receive monthly payouts.

Once you submit the form, the Klefki team will verify your app and respond within 24 hours. Verification includes checking if you have received a sample payment to the payment details your have shared while creating the App on Kleki. Every "Launched" app is visible on Explore page and once its verified by the Klefki team, it becomes available for users to onboard.

3. Using the Klefki API

After approval, integrate Klefki into your application using two APIs:

• Make Expense API (mandatory)
• Validate Key API (optional but recommended)

3.1 Make Expense API

Should get triggered when a user uses your tool.

Endpoint

POST https://klefki-backend-fra.onrender.com/klefki-api

Payload

{
  "expense_UKK": "<user's klefki key> (to be added by user)",
  "expense_value": <credits deducted per usage>,
  "tool_ID_byDev": "<your tool ID>"
}

How to find your Tool ID?

Go to:
Owned Apps → Click your app → Download Expenses (against any user)
A PDF will open showing logs and the Tool ID at the top.

3.2 Validate Key API (Optional but Recommended)

Before performing an operation, user can check if a their Klefki Key is valid. This also prepares Klefki backend for the upcoming transaction. A response with status code 200 means that the klefki key user has shared is valid.

Endpoint

GET https://klefki-backend-fra.onrender.com/api/validate/ukk

Payload

{
  "key": "<user's klefki key>"
}

4. (Sample) Python Implementation

Validate Klefki Key

import requests

def validate_klefki_key(klefki_key):
    try:
        response = requests.get(
            "https://klefki-backend-fra.onrender.com/api/validate/ukk",
            json={"key": klefki_key},
            timeout=10
        )
        return response.json()
    except Exception as e:
        return {"error": str(e)}

Send Usage Event (Make Expense)

import requests

def send_usage_event(user_ukk, credits, tool_id):
    payload = {
        "expense_UKK": user_ukk,
        "expense_value": credits,
        "tool_ID_byDev": tool_id,
    }

    try:
        response = requests.post(
            "https://klefki-backend-fra.onrender.com/klefki-api",
            json=payload,
            timeout=10
        )
        return response.json()
    except Exception as e:
        return {"error": str(e)}

5. Terms & Conditions for Developers

• Strictly prohibited: storing, logging, or misusing any user's Klefki Key (UKK).
• Any developer found doing so will be banned from the Klefki Keys platform.
• Usage-based charges must reflect actual use.
• Developers must ensure secure API communication.

User Documentation

1. Getting Started

Visit https://klefkikeys.netlify.app/ and login using Google.
All users get 10 credits by default.
1 credit = 1 INR.

2. Exploring Tools

Go to the Explore section to browse apps created by developers. All the apps you can see on this page are in "Launched" state. If any app is faded (not clickable) that means it is under verification and should be available to onboard within 24 hours. Click Onboard to start using any tool. Click on an onboarded app's name to get its klefki key. (Can't see klefki key? Try logout and re-login.)

3. Getting Your Unique UKK (User Klefki Key)

Once you onboard a tool:

• Click the tool from your dashboard.
• You will see your unique User Klefki Key (UKK).
• Click "OK" to copy it to your clipboard.

Important Notes

• Your UKK is confidential.
• Never share it with anyone.
• Only use it inside the app/tool you onboarded.

4. Tracking Your Expenses

Go to Balance History to track:

• How many credits you spent
• On which tools
• Expense logs per usage

End of Documentation