Marketplace

Опублікування додатка на marketplace робить його доступним для виявлення та встановлення іншими Kazzle просторами.

Що робить опублікування

Опублікування робить додаток придатним для встановлення іншими просторами. Люди бачать назву додатка, підзаголовок, значок, видавця та видимість, а потім встановлюють його у свій простір. Опублікування вимагає subtitle у kazzle.config.ts — однорядкового слогану під назвою додатка. Опублікована версія використовує останній коміт на main. Для опублікованих додатків немає окремої гілки випуску. За замовчуванням клацання на опублікований додаток відкриває його розгорнутий інтерфейс. Додатки можуть опціонально встановити користувацький URL запуску, вимагати ідентифікацію Kazzle перед відкриттям або отримувати вебхуки встановлення та видалення. Див. Опублікуйте свій додаток, щоб дізнатися, як опублікувати додаток.

Встановлення

Коли хтось встановлює опублікований додаток, Kazzle створює запис про встановлення всередині його простору. Простір, який встановлює, володіє встановленням та будь-якими пов’язаними з ним даними.

Ідентифікація користувача

Коли авторизований користувач Kazzle відкриває встановлений додаток, Kazzle надає додатку інформацію про поточного користувача. Kazzle додає короткотривалий JWT як токен носія. Додаток може перевірити токен за допомогою публічного JWKS Kazzle, щоб прочитати користувача, простір та встановлення. Токен містить ці претензії:

Претензія	Значення
`aud`	`kazzle:app`
`iss`	`https://api.kazzle.app`
`sub`	ID користувача Kazzle
`user`	`{ id, email }` користувача
`space`	ID простору, в якому встановлено додаток
`install`	ID цього конкретного встановлення

Приклад перевірки:

import { jwtVerify, createRemoteJWKSet } from 'jose';

const JWKS = createRemoteJWKSet(new URL('https://api.kazzle.app/auth/.well-known/jwks.json'));

async function getUserFromToken(token: string) {
  const { payload } = await jwtVerify(token, JWKS, {
    audience: 'kazzle:app',
    issuer: 'https://api.kazzle.app',
  });
  return payload;
}

Два поля в маніфесті додатка контролюють поведінку запуску для опублікованих додатків:

kazzleAuth: required означає, що тільки авторизовані користувачі Kazzle можуть відкрити додаток; optional дозволяє відкрити додаток без ідентифікації Kazzle.
launchUrl: замінює точку входу, яка відкривається, коли користувач клацає на додаток.

Вебхуки

Якщо маніфест включає webhookUrl, Kazzle надсилає HTTP POST запити до нього при встановленні або видаленні додатка. app.installed включає ключ встановлення, який бекенд видавця може використовувати для автентифікації до API для кожного встановлення:

{
  "event": "app.installed",
  "installId": "...",
  "appId": "...",
  "spaceId": "...",
  "apiUrl": "https://api.kazzle.app",
  "installKey": "kzl_inst_...",
  "user": { "id": "...", "email": "..." }
}

app.uninstalled містить подію, ID встановлення, ID додатка, ID простору та URL API. Видавець повинен припинити використання ключа встановлення після отримання цієї події.

API для кожного встановлення

Кожне встановлення може викликати обмежений API на https://api.kazzle.app. Виклики автентифікуються за допомогою ключа встановлення (з бекенду видавця) або токена ідентифікації користувача (з розміщеного інтерфейсу). Усі операції автоматично обмежені цим встановленням. Доступні кінцеві точки: Повні схеми запитів та відповідей опубліковані в специфікації OpenAPI Kazzle за адресою https://api.kazzle.app/openapi.json під цими шляхами.

Метод	Шлях	Опис
GET	`/apps/secrets`	Список назв секретів, збережених для встановлення
GET	`/apps/secrets/:name`	Прочитати значення секрету
PUT	`/apps/secrets/:name`	Зберегти значення секрету
DELETE	`/apps/secrets/:name`	Видалити секрет
GET	`/apps/metadata`	Прочитати неконфіденційні метадані для встановлення
PUT	`/apps/metadata`	Об’єднати оновлення в метадані встановлення

Секрети, записані через цей API, зашифровані в спокої та ізольовані для конкретного встановлення. Вони відокремлені від секретів, збережених у сховищі простору.

Наступні кроки

Опублікуйте свій додаток — як опублікувати додаток та що відбувається далі.
Конфігурація — повна довідка маніфесту, включаючи kazzleAuth, launchUrl та webhookUrl.

Початок роботи

Створення

Користувачі та дані

Публікація

Використання Kazzle

Безпека

Довідник

Marketplace

Marketplace

Що робить опублікування

Встановлення

Ідентифікація користувача

Вебхуки

API для кожного встановлення

Наступні кроки

​Marketplace

​Що робить опублікування

​Встановлення

​Ідентифікація користувача

​Вебхуки

​API для кожного встановлення

​Наступні кроки

Marketplace

Що робить опублікування

Встановлення

Ідентифікація користувача

Вебхуки

API для кожного встановлення

Наступні кроки