Перейти к содержанию

POST /give/pals/{player_identifier}

Конечная точка: POST /v1/pdapi/give/pals/<player_identifier>

Аутентификация: Токен носителя

Разрешение: REST.Pals.Give

Цель

Дает один или несколько Pals по идентификатору и уровню.

Параметры пути

  • player_identifier: UserId или PlayerUID для целевого игрока.

Параметры запроса

Нет.

Тело запроса

JSON object с Pals, array из Pal грантов. Для каждой записи требуется PalID и положительный Level.

Схема ответа

200 response schema

Field Type Description
Granted object Counts granted by the request.

Granted object schema:

Field Type Description
Pals integer Number of Pals granted.

Реакции на ошибки

Тела ошибок используют следующую форму:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Human-readable message",
        "Details": {}
    }
}
HTTP Код ошибки Когда это произойдет
401 INVALID_TOKEN Заголовок Authorization отсутствует, имеет неправильный формат или не соответствует настроенному токену носителя.
403 MISSING_PERMISSION Токен действителен, но не включает это разрешение конечной точки.
400 INVALID_JSON Текст запроса был предоставлен, но его не удалось проанализировать как JSON.
400 REQUEST_FAILED Обратный вызов игрового потока вызвал исключение, или произошел сбой общего преобразователя player/resource.
500 REQUEST_TIMEOUT Обратный вызов внутреннего игрового потока не завершился в течение 5 секунд.
400 INVALID_REQUEST Тело не содержит Pals array.
400 VALIDATION_FAILED Один или несколько грантов Pal недействительны, или у игрока недостаточно места для хранения Pal.

Примеры

Дайте стартовый Pal игроку GDK.

POST /v1/pdapi/give/pals/gdk_2533274812345678
{
    "Pals": [
        { "PalID": "Pengullet", "Level": 10 }
    ]
}

Дайте событию Pals по PlayerUID

POST /v1/pdapi/give/pals/b7f4e91a-2c53-4d8f-a6e1-93c4bb62a7d1
{
    "Pals": [
        { "PalID": "Anubis", "Level": 35 },
        { "PalID": "Kitsun", "Level": 25 }
    ]
}

Сценарии

  • Предоставляйте простые награды Pal без сохранения файла шаблона.
  • Используйте для сценариев случайных наград, которые различаются только PalID и Level.
  • Запрос может завершиться неудачно, если игрок не может быть найден, PalID недействителен или недостаточно места для хранения Pal.