Головна/Довідник/Глосарій ENУКРРУС API-довідник (ReDoc) ↗

Глосарій

Дюжина термінів, які ця wiki вживає точно.

Вендор — компанія за API провайдерів (deepl, amazon). Володіє провайдерами в каталозі. Vendors and Providers

Провайдер — один конкретний API-продукт вендора (deepl_api, amazon_translate); одиниця, проти якої зберігаються credentials.

Каталог — версіонований YAML, що описує вендорів, провайдерів, схеми, можливості (capabilities) й політики; read-only через API, однаковий для всіх. Його рядок версії їде як catalog_version.

Credential — один збережений запис: зашифрований секретний об'єкт плюс відкрита конфігурація, у власності користувача, організації або платформи.

Credential schema / configuration schema — JSON Schema провайдера для секретної та несекретної частин credential. Provider Schemas

Рівень власності (owner type) — кому належить credential: user, organization чи platform. Каталог вирішує для кожного провайдера, які рівні можуть існувати. Core Concepts

Default — той єдиний credential на пару (провайдер, власник), який вибирає resolve; щонайбільше один активний default на scope. Defaults and Lifecycle

Resolve — операція сервісної площини, що відповідає на «на якому credential має працювати переклад цього користувача», йдучи USER → ORGANIZATION → PLATFORM. Повертає plaintext.

Reveal — операція операторської площини, що показує plaintext одного credential названій людині; окремо скоуплена, з обов'язковою атрибуцією, з audit-записом до відповіді. Reveal

Маска (masked_credentials) — замаскована форма, яку повертає кожне читання: впізнати можна, скористатися — ні. Personal Credentials

Площина — одна з двох поверхонь API: користувацька площина (/v1/*, exchange-JWT) і сервісна площина (/internal/v1/*, client-credentials токени зі scope). User Plane Tokens · Service Plane Tokens

Scope — одиниця дозволу сервісної площини: provider-credentials.invoke / .admin / .reveal; жоден не включає інший.

Exchange-токен — короткоживучий користувацький JWT, викарбуваний рівно для цього сервісу (audience: provider-credentials-service).

Менеджер організації — той, чия сира org-роль входить у JWT_ORG_MANAGER_ROLES (за замовчуванням owner/admin); єдина ідентичність, що може читати чи писати credentials організації.

М'яке видалення / вікно відновлення — видалення миттєво ховає запис; шифротекст живе ще кілька днів (за замовчуванням 5) до фізичного purge. Defaults and Lifecycle

Оптимістичне блокування (version) — кожна мутація називає версію, яку прочитала; застарілі записи програють із 409. Errors and Conventions

Audit-подія — незмінний запис, який лишає кожна значуща дія; секрети не потрапляють туди ніколи. Audit Events

Correlation id — id запиту, що нанизує клієнтський виклик → логи сервісу → audit-стрічку; ваш, якщо ви його надішлете.