> ## 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 uk/openapi/uk-api-v3-openapi.yaml POST /keys
openapi: 3.1.0
info:
  title: ER:LC Росія API V3
  description: >-
    API ER:LC Russia: сервери, користувачі, 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: >-
      Каталог планів, замовлення FunPay, нарахування бенефітів та активація
      підписок.
  - name: API Авторизації
    description: >-
      Вхід через Discord та Roblox OAuth2, керування сесіями користувача та
      зв'язування акаунтів.
  - name: API Управління - WebSocket Ключі
    description: Керування ключами доступу до WebSocket шлюзу та підписками на канали.
  - name: API Управління - Вебхукі
    description: Реєстрація, валідація доступності та моніторинг власних вебхуків.
  - name: API Управління - Панель
    description: >-
      Управління користувачами, підписками, тарифами, ручний баланс та системна
      статистика.
  - name: API Стану
    description: Моніторинг працездатності сервісу, підключень до PostgreSQL та Redis.
  - name: AI Audio
  - name: AI Studio
  - name: API Адмінки - Сервера
  - name: API Ключів
  - name: API Управління - Сервери
  - name: API Управління - Токени
  - name: CDN
  - name: CDN V3
  - name: CDN Домени
  - name: Адміністрація E-Coins
  - name: Адміністрування AI
  - name: Користувальницькі Вебхуки
  - name: Особисті файли та бібліотека
  - name: Редиректи організацій V3
  - name: Рекламные кампании V3
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.