paper-scroll

Здесь представлен список доступных секций и методов API игры Paper Scroll.

Любые вопросы о работе API вы можете задать в нашем сообществе для разработчиков ВКонтакте или специальной беседе.

Для отправки запросов вам необходимо создать магазин внутри приложения и получить к нему ключ доступа по ссылке vk.com/app7420483#create_merchant

Информацию о готовых SDK можно найти по ссылкам:
Node.JS: github.com/KotRikD/paper-scroll-sdk-node
Python: github.com/KotRikD/paper-scroll-sdk-py
PHP: github.com/nikitos42050/paper-scroll-sdk-php

Приложение поддерживает быстрые ссылки, открывающие окно перевода вашему магазину.

Ссылка состоит из нескольких параметров: vk.com/app7420483#m{merchant_id}_{amount}_{payload}_{is_locked}

• merchant_id: Идентификатор вашего магазина

• amount: Предлагаемая сумма перевода в тыс. долях рулонов

• payload: Полезная нагрузка в переводе

• is_locked: Флаг, запрещающий редактирование предложенной суммы

Пример такой ссылки: vk.com/app7420483#m1_1000000_50_0
Или самый короткий вариант: vk.com/app7420483#m1

С помощью метода webhooks.create вы можете настроить отправку уведомлений о событиях в игре на собственный сервер. Данные отправляются методом POST в формате application/json.

На данный момент поддерживаются события: transfer_new.

Пример отправляемого события:

{
    "event": "transfer_new",
    "object": {
        "transfer_id": 37356,
        "external_id": 37357,
        "owner_id": -1,
        "peer_id": 100772411,
        "is_initiator": false,
        "payload": 100,
        "type": "transfer",
        "object_type": "balance",
        "object_type_id": 0,
        "message": "",
        "amount": 1000,
        "create_date": 1590134400
    },
    "secret": "yQ7Z1LDDG83Q8r8Ym9Yu2aXzBc51T06Q"
}

Событие считается успешно отправленным, если ответ сервера содержит HTTP код 200 OK.

Данные запросов и ответов передаются в формате JSON в кодировке UTF-8.
Базовый адрес для отправки запросов: https://paper-scroll.ru/api/{method}

К каждому отправляемому запросу необходимо добавлять заголовок Authorization с типом Basic и base64-закодированной строкой merchant_id:access_token (не пропустите двоеточие между двумя строками).

Например: Authorization: Basic MjozNTJlYTIyMTZlZDEzYmZhMDlhNTk0ZQ==

С использованием одного ключа доступа можно отправить не больше 3 запросов в секунду.

Также для каждого IP адреса имеется лимит на 10 запросов в секунду.

Ошибки API всегда возвращаются с HTTP кодом 400 Bad Request и имеют общий формат:

{
    "error": {
        "error_code": 1,
        "error_msg": "Internal error",
        "error_text": "Внутренняя ошибка сервиса, повторите запрос позже"
    }
}

Основной список ошибок, возвращаемых для всех методов:

• #1 - Internal error (Внутренняя ошибка сервиса)

• #2 - Authorize error (Неверно передан ключ доступа)

• #3 - Access error (Ошибка доступа к секции/методу)

• #4 - Flood limit (Превышен лимит на частоту обращений)

• #5 - Unknown method (Не определена секция/метод API)

• #6 - Invalid params
  (Неверно переданы параметры к запросу.
  Возвращается, если для метода не опредлены собственные типы ошибок.)

Также в ходе выполнения запроса могут произойти специальные ошибки, уникальные для каждого метода.