Общая информация

Запросы можно делать по адресу https://welldungeon.online/api/v1/МЕТОД (список методов см. ниже) с частотой, не превышающей 3 раза в секуду с одного IP-адреса

Формат ответа: JSON

Успешно выполненный метод возвращает "result":1 и другие переменные. Ошибка вернёт "result":0, а также error.code c ID ошибки и error.message с детальным описанием.

Токен

Токен - секретная строка вида wd1_live_64_random_chars...A42x для доступа к выполнению методов от имени вашего персонажа, отправляется параметром token вместе с запросов к методу. Храните токен в тайне, чтобы избежать несанкционированного доступа к персонажу и инвентарю.

Вы можете сгенерировать до 5 разных токенов на странице приложения: https://welldungeon.online/?act=tokens

В целях безопасности токен показывается только один раз, а установленные при создании права и белый список IP не редактируется

Типы ошибок

• INVALID_TOKEN - Токен не найден, отозван или неактивен
• FORBIDDEN_SCOPE - У токена нет права на данный метод
• UNKNOWN_METHOD - Неизвестный метод
• VALIDATION_ERROR - Невалидные или отсутствующие параметры
• TARGET_NOT_FOUND - Целевой игрок/предмет/эффект не найден
• INSUFFICIENT_VOICES - Недостаточно голосов для операции
• ON_COOLDOWN - Действие на кулдауне
• CONDITIONS_NOT_MET - Не выполнены условия выполнения действия, например не соответствует уровень или класс
• INVENTORY_ERROR - Ошибка инвентаря (нет предмета, слот занят и т.п.)
• GUILD_PERMISSION_DENIED - Нет ранга для операции со складом
• INTERNAL_ERROR - Внутренняя ошибка сервера
• UNDER_CONSTRUCTION - Метод в разработке, временно недоступен
• WRONG_IP - IP-адрес не в белом списке
• TOO_MANY_REQUESTS - Превышен лимит частоты обращений к API

Уровни доступа

При создании токена можно установить уровни доступа

• character_info - Информация по персонажу
• inventory_read - Просмотр содержимого инвентаря
• transfer_player_to_player - Передача предметов между игроками
• social_effects_player_to_player - Наложение социальных эффектов
• guild_warehouse_deposit - Передача предметов на склад гильдии
• guild_warehouse_withdraw - Передача предметов со склада гильдии

Белый список IP

Если вы планируете использовать токен с одного сервера, рекомендуется привязать к токену его IP-адрес. API будет отклонять запросы с этим токеном, сделанные с других IP.

Методы

GetCharacterInfo

Требуемое право: character_info

Получение информации о состоянии персонажа.

Классы и номера:
0 - нет класса
1 - рыцарь
2 - тень
3 - мистик
4 - паладин
5 - палач
6 - ассасин
7 - кровопийца
8 - хранитель тайн
9 - чернокнижник
10 - крестоносец
11 - воплощение света 
12 - потрошитель
13 - берсеркер
14 - королевский убийца
15 - клинок тьмы
16 - отрекшийся
17 - прокаженный
18 - апостол
19 - верховный маг
20 - жнец душ
21 - повелитель мрака

GetInventory

Требуемое право: inventory_read

Информация об инвентаре. Приходит в кратком виде ID предмета:количество, для расшифровки названий используйте метод LibItems

TransferItemToPlayer

Передача предметов между игроками

Требуемое право: transfer_player_to_player

Параметры:

player_id - ВКонтакте ID кому передать предмет (обязательный параметр)

item_id - ID предмета (обязательный параметр)

count - Количество, от 1 до 9999, по умолчанию 1

ApplySocialEffectToPlayer

Наложение социального эффекта

Параметры:

player_id - ВКонтакте ID на кого накладываем эффект (обязательный параметр)

type - Тип эффекта, может зависеть от класса персонажа и других условий (обязательный параметр)

Возможные типы:

BlessOfAttack - благословение атаки

BlessOfDefense - благословение защиты

BlessOfLuck - благословение удачи

BlessOfHuman - благословение расы (человек)

BlessOfElf - благословение расы (эльф)

BlessOfOrk - благословение расы (орк)

BlessOfGoblin - благословение расы (гоблин)

BlessOfGnome - благословение расы (гном)

BlessOfDemon - благословение расы (демон)

BlessOfUndead - благословение расы (нежить)

BlessOfHero - благословение героя

BlessOfEvent - благословение с ивентов

BlessOfFire - благословение огня

BlessOfLight - благословение света

Resurrect - воскрешение, доступно паладину на игроков, чей уровень меньше.

BlessClear - очищение

CurseOfPain - проклятие боли

CurseOfLoot - проклятие добычи

CurseOfUnluck - проклятие неудачи

FullHeal - вылечить травмы

LibItems

Справочник ресурсов с названиями, признаками занимаемого места, возможности передачи и размещения на аукционе. Рекомендуется скачать этот справочник и кэшировать на стороне вашего приложения, а обращаться к нему в случае, если в ответах от других методов вам приходят ID, которых в кэшированном справочнике нет.

{
    "result":1,
    "items":{
        "13322":{
            "title":"Золото",
            "transmit":true,
            "auction":true,
            "space":false
        },
        "13344":{
            "title":"Свободное место",
            "transmit":false,
            "auction":false,
            "space":false
        },
        ...
    }
}

TokenInfo

Информация о текущем токене, установленные права и ID пользователя.

• user_id - внутриигровой ID
• user_vk_id - ВКонтакте ID
• rights - массив установленных прав
• ips - массив разрешённых IP-адресов

{
    "result":1,
    "id":8,
    "user_id":3,
    "user_vk_id":4803497,
    "rights":["character_info","inventory_read","transfer_player_to_player"],
    "ips":[]
}

Log

Получение логов по вызовам этого токена, начиная с конца

start - С какой записи начать, по умолчанию 0

limit - Сколько записей вернуть, по умолчанию 100

{
   "result":1,
   "logs":[
      {
         "time":"2026-05-31 23:19:09",
         "ip":"45.151.69.81",
         "method":"ApplySocialEffectToPlayer",
         "error_code":"CONDITIONS_NOT_MET",
         "result":0,
         "answer":{
            "result":0,
            "error":{
               "code":"CONDITIONS_NOT_MET",
               "message":"Не удалось применить эффект. Сообщение: 🚫@id4803497 (Доброслав), Вы не являетесь Паладином, чтобы выполнять это действие!"
            }
         }
      },
      ...
   ]
}