> ## 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` и/или `WebSocket`. Прежний токен аннулируется, а все связанные настройки, подписки и ограничения прав переносятся на вновь сгенерированный токен.

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

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

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

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

| Параметр | Тип | Описание |
| :- | :- | :- |
| `api` | `boolean` | Перегенерировать HTTP API токен (`true`). |
| `websocket` | `boolean` | Перегенерировать WebSocket токен (`true`). |

> [!NOTE]
>
> Хотя бы один из параметров (`?api=true` или `?websocket=true`) является обязательным. При передаче `?api=true&websocket=true` будут перегенерированы оба ключа одновременно.

Ротация одного ключа разрешена раз в пять минут; при 429 учитывайте Retry-After. Успешная ротация записывается в аудит с ID ключа и IP, без секрета.


## OpenAPI

````yaml ru/openapi/ru-api-v3-openapi.yaml POST /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:
    post:
      tags:
        - API Ключей
      summary: Новые ключи
      description: >-
        Перевыпускает API- и/или WebSocket-ключ. Старый перестаёт работать,
        права и подписки переходят на новый.


        Ротация одного ключа разрешена раз в пять минут; при 429 учитывайте
        Retry-After. Успешная ротация записывается в аудит с ID ключа и IP, без
        секрета.
      parameters:
        - name: api
          in: query
          description: Перегенерировать HTTP API ключ
          schema:
            type: boolean
          example: true
        - name: websocket
          in: query
          description: Перегенерировать WebSocket ключ
          schema:
            type: boolean
          example: true
      responses:
        '200':
          description: Токен(ы) успешно перегенерирован(ы).
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  oldToken:
                    type: string
                  newToken:
                    type: string
                  token:
                    type: string
                  apiKey:
                    type: string
                  key:
                    type: string
                  userId:
                    type: string
                  serverId:
                    type: string
              example:
                success: true
                message: API key regenerated successfully
                oldToken: a8Fk2L...hJkL
                newToken: Zp4Kq9LmQ2xXc7VbN3sDf6GhJ1kLp0QwErTyUiOpAsDfGhW8
                token: Zp4Kq9LmQ2xXc7VbN3sDf6GhJ1kLp0QwErTyUiOpAsDfGhW8
                apiKey: Zp4Kq9LmQ2xXc7VbN3sDf6GhJ1kLp0QwErTyUiOpAsDfGhW8
                key: Zp4Kq9LmQ2xXc7VbN3sDf6GhJ1kLp0QwErTyUiOpAsDfGhW8
                userId: '123456789012345678'
                serverId: '12345678'
        '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.