> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.erlcrussia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Мои ключи

> Ваши API- и WebSocket-ключи. Укажите `api=true` и/или `websocket=true`; `restrictions=true` добавляет права.

Универсальный эндпоинт для получения списка токенов (`API` и `WebSocket`) и их прав/ограничений.

### Авторизация

Заголовок `erlcrussia-api-key` **не является строго обязательным**, если вы используете WebSocket-ключ. Вы можете передать:

* `erlcrussia-api-key` — для авторизации и работы с HTTP API ключами (`?api=true`).
* `erlcrussia-websocket-key` — для авторизации и работы с WebSocket ключами (`?websocket=true`).
* Либо оба заголовка одновременно.

### Query-параметры

| Параметр | Тип | Описание |
| :- | :- | :- |
| `api` | `boolean` | Запросить HTTP API ключи (`true`). |
| `websocket` | `boolean` | Запросить WebSocket ключи (`true`). |
| `restrictions` | `boolean` | Включить ограничения для предыдущего типа ключа (`true`). |

> [!TIP]
>
> Параметр `restrictions=true` привязывается к предшествующему параметру типа. Например:
>
> * `?api=true&restrictions=true` — вернет API ключи с их ограничениями.
> * `?api=true&websocket=true&restrictions=true` — вернет API ключи без ограничений и WebSocket ключи с ограничениями.
> * `?api=true&restrictions=true&websocket=true&restrictions=true` — вернет оба типа ключей с ограничениями.

Полный секрет возвращается только при создании или ротации. Списки AI-ключей, переименование и удаление возвращают маску. В GET /keys полностью виден только вызывающий ключ; остальные, включая собственные соседние ключи, замаскированы. teamId — идентификатор привязанной команды или null.


## OpenAPI

````yaml ru/openapi/ru-api-v3-openapi.yaml GET /keys
openapi: 3.1.0
info:
  title: ER:LC Россия API V3
  description: >-
    API ER:LC Россия: серверы, пользователи, CDN, редиректы, подписки и ключи
    доступа.
  version: 3.0.0
servers:
  - url: https://api.erlcrussia.com/v3
    description: Основной сервер (com)
  - url: https://api.erlcrussia.xyz/v3
    description: Резервный сервер (xyz)
security: []
tags:
  - name: ER:LC Сервер
    description: Получение статуса, онлайна, списков игроков и персонала сервера ER:LC.
  - name: ER:LC Команды
    description: >-
      Отправка и постановка в очередь команд внутриигрового сервера (:h, :m,
      :kick, :ban и др.).
  - name: Экономика
    description: >-
      Взаимодействие с экономической системой (пользователи, бизнесы, мафии,
      магазин, реклама).
  - name: API Статистики
    description: >-
      Высокопроизводительное получение статистики дискорд-серверов и игровых
      серверов (онлайн, участники, боты).
  - name: API Верификации
    description: Поиск и сопоставление Discord ID и Roblox ID аккаунтов.
  - name: CDN Ассеты
    description: >-
      Загрузка, управление, статистика и очистка кэша файлов объектного
      хранилища MinIO / Edge CDN.
  - name: CDN Папки
    description: Иерархическая структура и сортировка папок медиатеки CDN.
  - name: API Наказаний
    description: Управление балансом и историей транзакций баллов игроков.
  - name: API Токенов
    description: Управление API токенами интеграции и проверка активных подписок.
  - name: API Подписок
    description: Каталог планов, заказы FunPay, начисление бенефитов и активация подписок.
  - name: API Авторизации
    description: >-
      Вход через Discord и Roblox OAuth2, управление сессиями пользователя и
      связывание аккаунтов.
  - name: Реальное Время и Вебхуки
    description: >-
      WebSocket шлюз событий и обработчик входящих вебхуков PRC с
      криптографической подписью Ed25519.
  - name: API Управления - Ключи
    description: Выпуск, аудит, деактивация и разграничение прав API ключей.
  - name: API Управления - Ограничения
    description: >-
      Тонкая настройка разрешенных версий, эндпоинтов, действий (actions) и
      query-параметров.
  - name: API Управления - WebSocket Ключи
    description: Управление ключами доступа к WebSocket шлюзу и подписками на каналы.
  - name: API Управления - Вебхуки
    description: Регистрация, валидация доступности и мониторинг пользовательских вебхуков.
  - name: API Управления - Панель
    description: >-
      Управление пользователями, подписками, тарифами, ручной баланс и системная
      статистика.
  - name: API Состояния
    description: Мониторинг работоспособности сервиса, подключений к PostgreSQL и Redis.
paths:
  /keys:
    get:
      tags:
        - API Ключей
      summary: Мои ключи
      description: >-
        Ваши API- и WebSocket-ключи. Укажите `api=true` и/или `websocket=true`;
        `restrictions=true` добавляет права.


        Полный секрет возвращается только при создании или ротации. Списки
        AI-ключей, переименование и удаление возвращают маску. В GET /keys
        полностью виден только вызывающий ключ; остальные, включая собственные
        соседние ключи, замаскированы. teamId — идентификатор привязанной
        команды или null.
      parameters:
        - name: api
          in: query
          description: Запросить список HTTP API токенов
          schema:
            type: boolean
          example: true
        - name: websocket
          in: query
          description: Запросить список WebSocket токенов
          schema:
            type: boolean
          example: true
        - name: restrictions
          in: query
          description: Включить ограничения прав (указывается после api или websocket)
          schema:
            type: boolean
          example: true
      responses:
        '200':
          description: >-
            Список запрошенных ключей (массив или объект при одновременном
            запросе api и websocket).
          content:
            application/json:
              schema:
                type: object
                properties:
                  api:
                    type: array
                    items:
                      type: object
                      properties:
                        teamId:
                          type: string
                        id:
                          type: string
                        key:
                          type: string
                        apiKey:
                          type: string
                        userId:
                          type: string
                        serverId:
                          type: string
                        isActive:
                          type: boolean
                        createdAt:
                          type: string
                          format: date-time
                        restrictions:
                          type: object
                          properties:
                            endpoints:
                              type: array
                              items:
                                type: string
                            versions:
                              type: array
                              items:
                                type: string
                            queryParams:
                              type: array
                              items:
                                type: string
                            actions:
                              type: array
                              items: {}
                  websocket:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        key:
                          type: string
                        apiKey:
                          type: string
                        userId:
                          type: string
                        serverId:
                          type: string
                        isActive:
                          type: boolean
                        createdAt:
                          type: string
                          format: date-time
                        restrictions:
                          type: object
                          properties:
                            channels:
                              type: array
                              items:
                                type: string
                            blockedIPs:
                              type: array
                              items: {}
              example:
                api:
                  - teamId: team_7f3a
                    id: '15'
                    key: a8Fk2LmQ9zXc7VbN3sDf6GhJ1kLp0QwErTyUiOpAsDfGhJkL
                    apiKey: a8Fk2LmQ9zXc7VbN3sDf6GhJ1kLp0QwErTyUiOpAsDfGhJkL
                    userId: '123456789012345678'
                    serverId: '12345678'
                    isActive: true
                    createdAt: '2026-10-21T12:00:00Z'
                    restrictions:
                      endpoints:
                        - erlc.server
                      versions:
                        - v3
                      queryParams:
                        - query:Players
                      actions: []
                websocket:
                  - id: '4'
                    key: ws_K3j...hJkL
                    apiKey: ws_K3j...hJkL
                    userId: '123456789012345678'
                    serverId: '12345678'
                    isActive: true
                    createdAt: '2026-10-21T12:00:00Z'
                    restrictions:
                      channels:
                        - players
                      blockedIPs: []
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - ApiKeyHeader: []
        - WebSocketKeyHeader: []
        - ApiKeyHeader: []
          WebSocketKeyHeader: []
components:
  responses:
    BadRequestError:
      description: Bad Request (400) — неверные параметры запроса.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missing_params:
              summary: Missing Parameters (5002)
              value:
                code: 5002
                message: Missing Parameters
            invalid_json:
              summary: Invalid JSON (5034)
              value:
                code: 5034
                message: Invalid Json
            invalid_param:
              summary: Invalid Param Name (5004)
              value:
                code: 5004
                message: Invalid Param Name
    UnauthorizedError:
      description: Unauthorized (401) — отсутствует или недействителен API токен.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missing_token:
              summary: Missing Token (5007)
              value:
                code: 5007
                message: Missing Token
            invalid_token:
              summary: Invalid Token (5008)
              value:
                code: 5008
                message: Invalid Token
    InternalServerError:
      description: Internal Server Error (500) — внутренняя ошибка сервера.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internal:
              summary: Internal Error (5017)
              value:
                code: 5017
                message: Internal Error
  schemas:
    ErrorResponse:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: integer
          example: 5009
          description: Числовой код ошибки ER:LC Россия API.
        message:
          type: string
          example: Forbidden
          description: Системное сообщение ошибки на английском языке.
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: erlcrussia-api-key
      description: >-
        Пользовательский API-ключ. Храните на сервере; не включайте в клиентский
        JavaScript.
    WebSocketKeyHeader:
      type: apiKey
      in: header
      name: erlcrussia-websocket-key
      description: Единый заголовок WebSocket-ключа erlcrussia-websocket-key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.