> ## 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 — ID прив’язаної команди або null.


## OpenAPI

````yaml uk/openapi/uk-api-v3-openapi.yaml GET /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:
    get:
      tags:
        - API Ключів
      summary: Мої ключі
      description: >-
        Ваші API- і WebSocket-ключі. Вкажіть `api=true` та/або `websocket=true`;
        `restrictions=true` додає права.


        Повний секрет повертається лише під час створення або ротації. Списки
        AI-ключів, перейменування та видалення повертають маску. GET /keys
        розкриває лише ключ виклику; інші ключі, навіть власні, замасковані.
        teamId — ID прив’язаної команди або 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.