Документация

REFL.ME работает очень просто. Пользователь скачивает приложение и добавляет ссылку на источник данных. После этого приложение с заданным интервалом опрашивает источник данных и получает ответы в формате JSON. На основе этих ответов приложение показывает сообщения и уведомления.

Подключить приложения REFL.ME к Вашему веб-сервису очень легко. Просто обрабатывайте на стороне своего веб-сервиса GET запросы от приложения и формируйте соответствующие ответы в JSON. Для работы достаточно JSON ответа с двумя обязательными ключами "refl.me" и "message".

Ключ "refl.me" всегда должен быть true, иначе будет вызвана ошибка. Допускается написание "refl_me".
Ключ "message" отвечает за текст уведомления. Максимальная длина сообщения 360 символов. Пустые "message" игнорируются.
Чтобы создать оповещение в приложении, просто измените значение ключа «message» на отличное от предыдущего значения.

Минимальный JSON

{
        "refl.me":true,
        "message":"Hello!"
}

Пример на PHP

<?php
        header('Content-Type: application/json');
        $json_array = array('refl.me'=>true,'message'=>'Hello!');
        echo json_encode($json_array);
?>


Расширенный JSON

{
        "refl.me":true,
        "title":"Test",
        "message":"Hello!",
        "image":"https://refl.me/img/reflme.png",
        "go_link":"https://refl.me/",
        "refresh":96,
        "stealth":false,
        "close":false
}

"title" - заголовок уведомления (максимум 36 симвовлов).
"image" - http(s) ссылка на изображение.
"refresh" - количество проверок за 24 часа (0 - ручное обновление, 288 - максимум, 96 - по умолчанию).
"go_link" - http(s) ссылка на страницу с полной информацией (отображает кнопку для перехода).
"stealth" - задайте "true", если хотите обновить данные на устройстве пользователя без оповещения.
"close" - задайте "true", если хотите закрыть источник для обновлений на устройстве пользователя.

Источник для теста (используйте в приложении)

https://refl.me/test

REFL.ME позволяет дополнительно запрашивать у пользователя приложения ключ (key) и формировать на его основе подпись запроса (secret). Это гарантирует дополнительную безопасность и аутентификацию пользователя на стороне веб-сервиса. Рекомендуем контролировать время запроса (time_stamp) для дополнительной защиты.

JSON с подписью запроса

{
        "refl.me":true,
        "message":"Hello!",
        "use_secret":true,
        "secret_ok":false
}

"use_secret" - задайте "true", если хотите включить контроль подписи (secret).
"secret_ok" - задайте "true", если подпись верная, "false", если подпись неверная (покажет форму запроса ключа).

После того, как пользователь ввел ключ, приложение каждый раз формирует и передает подпись (secret) GET запросом.
Формат подписи запроса (secret): [time_stamp]_[md5(time_stamp+key)]
Например, если time_stamp=1562272021 и key="test", тогда подпись запроса (secret) будет 1562272021_ed6808c7d7b53cc71c42c2f1aad0742f

Пример получения и проверки подписи на PHP

<?php


        $key="test";

        $secret_array=explode("_",$_GET['secret']);
        $time_stamp=$secret_array[0];
        $checksum=$secret_array[1];

        if(md5($time_stamp.$key)===$checksum)
        {
        $secret_ok = true;
        $message="Привет!";
        }
        else
        {
        $secret_ok = false;
        $message="Ошибка. Введите секретный ключ.";
        }

        $json_array = array();
        $json_array['refl.me']=true;
        $json_array['message']=$message;
        $json_array['use_secret']=true;
        $json_array['secret_ok']=$secret_ok;

        header('Content-Type: application/json');
        echo json_encode($json_array);

?>

Пример для теста в приложении (пароль: test)

https://refl.me/test_secret

User-Agent

refl.me;[язык приложения];[уникальный идентификатор]

Deeplink

https://refl.me/+http://ссылка на источник данных
reflme://+http://ссылка на источник данных

Если Вам понравилось приложение, расскажите о нем своим друзьям ;)
Большое спасибо за проявленный интерес!


Сообщить

Сообщить мне о выходе iOS версии (скоро)