@agru/sdk

agru-sdk

Мост между iframe игры и ag.ru

Как это работает:

Необходимо подключить файл с кодом моста (В дальнейшем будет размещен на CDN):

<script src='https://ag.ru/agru-sdk/dist/index.min.js'></script>

Параметры iframe приложения

Iframe приложение загружается с передачей следующих GET-параметров:

exe_user - идентификатор пользователя на сайте EXE.ru

game_sid - идентификатор текущей игровой сессии пользователя в игре

app_id - идентификатор приложения на сайте EXE.ru

auth_key - подпись значимых параметров. Формируется как md5($app_id . '' . $exe_user . '' . $secretKey), где $secretKey - секретный ключ, указанный в настройках приложения

Необходимо создать экземпляр SDK:

const props = {
    sdkSayHello: 'sdkSayHelloCallback',
    sdkSetSize: 'sdkSetSizeCallback',
};
const agRuApi = new AgRuSdk(props);
agRuApi.mount();

Конструктор класса принимает объект ключи в котором - это названия доступных методов, а значение - это название ф-и в которую будет возвращен результат (Если передан пустой объект, то название колбэка будет идентично названию вызываемого метода). Так же вторым аргументом можно включить debug режим. Если он включен, то мост будет возвращать в колбэки заглушки с тестовыми данными:

const props = {
    sdkGetGameInfo: 'sdkGetGameInfoCB',
};
const agRuApi = new AgRuSdk(props, true);
agRuApi.mount();

agRuApi.sdkGetGameInfo();

function sdkGetGameInfoCB(type, data) {
    console.log(type, data);
    /*
    * в debug моде получит значение
    *   {
    *    game_id: 1,
    *    game_sid: 0,
    *    success: true,
    *   }
    */
}

Для получения результатов от вызовов ф-й API необходимо объявить ф-и обратного вызова и передать их названия при создании экземпляра моста:

function sdkSayHello(type, data) {
    console.log(type, data);
}

function sdkSetSizeCB(type, data) {
    console.log(type, data);
}

Доступные, на данный момент, методы:

sdkSayHello

Просто выводит приветственную фразу, показывает, что инициализация произошла успешно

sdkSetSize

Устанавливает размеры iframe. Принимает объект с типом:

{
    width?: number;
    height?: number;
}

Возвращает:

{
    success: true
}

sdkGetGameInfo

Запрашивает регистрационную информацию об игре. Возвращает объект с типом:

{
    game_sid: number;
    game_id: number;
    success: true,
}

Где game_sid - идентификатор игровой сессии, game_id - идентификатор игры в системе ag.ru

sdkGetUserProfile

Запрашивает информации о пользователе в системе. Возвращает объект с типом:

{
    id: number;
    username: string;
    avatar?: string;
    success: true,
}

Кол-во возвращаемых полей будет меняться.

sdkIsAppUser

Возвращает информацию, относится ли пользователь к игре:

Параметры:

{
    // Идентификатор пользователя
    "user_id": 1
}

Ответ:

{
    success: boolean;
    message?: string;
}

getInstanceParams

Возвращает список полей которые были переданы как GET параметры при вызове iframe:

Ответ:

{
    ag_user: number,
    game_sid: number,
    app_id: number,
    auth_key: string,
}

sdkShowCampaign

Вызывает рекламную кампанию:

Ответ:

{
    closed: boolean,
    error: Error | null,
}

Ошибки

Если при запросе через API, что-то пошло не так, то все методы будут возвращать объект типа:

{
    success: boolean;
    message?: string;
}