Вики Provider Credentials
Руководство разработчика по каталогу провайдеров и хранилищу credentials — начните отсюда.
Это вики разработчика для Provider Credentials Service: единого источника правды о том, какие провайдеры машинного перевода и AI существуют и с какими credentials их вызывать. Сервис хранит каталог вендоров/провайдеров (схемы, возможности (capabilities), технические заметки) и зашифрованные credentials на трёх уровнях владения — пользователь, организация, платформа — и резолвит эффективный credential для запроса по фиксированной цепочке USER → ORGANIZATION → PLATFORM. Сам сервис никогда не вызывает внешних провайдеров.
Вы интегрируетесь по обычному HTTP, в одной из двух плоскостей: пользовательская плоскость (/v1/*, короткоживущие exchange-JWT от identity-провайдера) — для людей и продуктовых бэкендов, и сервисная плоскость (/internal/v1/*, токены OAuth 2.0 client-credentials с per-group scope) — для доверенных микросервисов. Секреты хранятся зашифрованными и всегда возвращаются маскированными; plaintext покидает сервис только через resolve и операторский reveal.
Каждая страница этой вики написана для интеграторов: вы вызываете эндпоинты и никогда не читаете наш исходный код. Описанное здесь поведение подкреплено контрактом API и тестовым набором; каждый сценарий cookbook зеркалит именованный тест.
Выберите свой путь
| Вы… | Начните отсюда |
|---|---|
| Новичок — просто хочу аутентифицированный вызов | Quickstart |
| Строите UI для credentials конечных пользователей | Provider Schemas, затем Сохраните свой первый credential |
| Админ организации, делящий один ключ с командой | Organization Credentials, затем Поделитесь org-credential |
| Рантайм перевода, которому нужны ключи для вызова провайдеров | Resolve Chain, затем Резолвите credentials |
| Оператор админ-панели или скриптов | Internal Admin API, Reveal, Audit Events |
| Настраиваете аутентификацию | User Plane Tokens · Service Plane Tokens |
Справочник API
Интерактивный ReDoc отдаёт сам API, в трёх локалях: английский, украинский, русский. Однострочная сводка всех операций со ссылками на владеющие ими вики-страницы — в Endpoints Index.
Карта разделов
00 Начало работы — Quickstart · Core Concepts · Errors and Conventions · Rate Limits
01 Каталог — Vendors and Providers · Provider Schemas · Full Catalog
02 Credentials — Personal Credentials · Organization Credentials · Defaults and Lifecycle · Credential Status
03 Resolve — Resolve Chain
04 Администрирование — User Plane Admin · Internal Admin API · Reveal · Audit Events
05 Интеграция — User Plane Tokens · Service Plane Tokens
07 Cookbook (исполняемые сценарии, каждый зеркалится тестом) — Просмотрите каталог · Сохраните свой первый credential · Ротируйте секрет · Управляйте default-записями · Поделитесь org-credential · Резолвите credentials · Администрируйте платформенные credentials · Раскройте credential · Прочитайте audit-ленту · Обработайте ошибки валидации
08 Справочник — Endpoints Index · Error Codes · Glossary
Две конвенции, которые стоит усвоить раньше всего остального
Каждый не-2xx ответ — один конверт: {"error": {"code", "message", "details", "correlation_id"}} — ветвитесь по code, никогда по прозе. И каждая мутация сохранённого credential требует текущей version записи (оптимистичная блокировка) — сначала прочитайте, потом пишите. Подробности в Errors and Conventions.