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

API работает по протоколу HTTP.

Формат запросов: обычные HTTP GET or POST, application/x-www-form-urlencoded

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

Сервер-сервер запросы

Сервер-сервер API проверяет авторизацию и IP адрес клиента.

Логин и секрет передаются с помощью Basic HTTP Authorization, в заголовке Authorization

Authorization: Basic base64('login:secret')

Логин и секрет и список разрешенных IP адресов могут быть изменены в настройках проекта.

Endpoint - https://mailer.mail.ru/

Отправка одного уведомления в Игровой Центр

POST /api/gcnotif/send/

Параметр Тип Описание Обязательное
uid int uid (ac_id/my.com_id/my.games_id) - для MY.GAMES пользователя Да
template int ID шаблона уведомления Да
pin.xxx string Дополнительные параметры для шаблона. pin.xxx будет доступно в шаблоне как {{ xxx }}. На все данные будет применен html_escape. Нет
pin.image_url string Особый параметр, он позволяет перекрыть картинку заданную в настройках шаблона. Нет
pin.image_rounded bool Особый параметр, закругляет картинку. Например, для аватара. Нет
pin.big_image_url string Особый параметр, он позволяет перекрыть большую картинку заданную в настройках шаблона. Нет
pin.project_name string Особый параметр, он позволяет перекрыть название проекта в настройках шаблона, (например, используется при добавлении в друзья, где вместо имени проекта - имя пользователя). Нет
resolve.not_check_subscription bool Не проверять подписавшихся / отписавшихся. Это сообщения будет отправлено любому пользователю, независимо от его подписки Нет
resolve.min_send_interval int время между отправками одного сообщения в секундах Нет

Успешная отправка

{
    "sent": 1,
    "status": "ok",
}

Отправка не удалась

{
    "sent": 0,
    "status": "fail",
}