Инструкция для разработчиков по подключению

Уведомляющий помощник по подключению приложений: обратите внимание на три требования к формату

1. Требования к формату конфигурационного файла.
2. Интерфейс входа в систему.
3. Требования к получению данных.

Правила обмена данными следующие:

1. Отправка и получение данных осуществляются в формате JSON.
2. Формат возвращаемых данных следующий:

{"code":200,"info":"получение успешно","data":[]}

Формат описания:

• code — при успешном выполнении бизнес-операции возвращается 200;
• code — при неудачном выполнении бизнес-операции возвращается 400;
• code — при ошибке сервера возвращается 500;
• info — информация о возврате;
• data — возвращаемые данные.

Конкретный формат интерфейса

1. Требования к формату интерфейса конфигурации

Получение:

Нет.

Возврат:

{
	"code": 200,
	"info": "получение успешно",
	"data": [
                {
                    "app_name": "Интеллектуальная карта",
                    "app_login_url": "https://sim.usr.cn/api/v1.Index/warnContent",
                    "app_news_url": "https://sim.usr.cn/api/v1.Index/warnContent",
                    "news_header": ["номер дела", "платформа", "уровень", "тема", "ответственный", "подающий заявку", "дата обновления"]
                }, {
                    "app_name": "OA",
                    "app_login_url": "https://sim.usr.cn/api/v1.Index/warnContent",
                    "app_news_url": "https://sim.usr.cn/api/v1.Index/warnContent",
                    "news_header": ["номер дела1", "платформа2", "уровень", "тема", "ответственный", "подающий заявку", "дата обновления"]
                }
            ]
}

Описание поля:

• app_name — название приложения, несколько названий приложений не могут быть одинаковыми, количество приложений не ограничено;

• app_login_url — адрес интерфейса входа;

• app_news_url — адрес получения уведомлений;

• news_header — данные заголовка уведомления.

Примечание:

• время ожидания составляет 10 секунд;

• при предоставлении этого подписного интерфейса пользователю адрес имеет формат http://sim.usr.cn/api/test, должен начинаться с http://;

• для подключения нескольких приложений поле data представляет собой двумерные данные, разработчикам необходимо обратить внимание;

• пользователь использует это программное обеспечение для заполнения адреса подписки (адрес этого интерфейса), после чего ему нужно только обновить список подписок в настройках, чтобы увидеть новые приложения, предоставленные разработчиком.

2. Формат интерфейса входа

Приём:

{
    "username" : "liuyexing",
    "password" : "123444"
}

Описание поля:

• username — имя пользователя;

• password — пароль.

Примечание:

• время ожидания — 5 секунд.

Возвращение:

{
	"code": 200,
	"info": "вход успешно",
	"data": []
}

3. Формат интерфейса уведомлений

Приём:

{
    "username" : "liuyexing",
    "password" : "123444"
}

Описание поля:

• username — имя пользователя;

• password — пароль.

Возвращение:

{
	"code": 200,
	"info": "получение успешно",
	"data": [
        {
            "url" : "https://www.baidu.com",
            "content" : [
                "123123",
                "123123",
                "123123",
                "123123",
                "123123"
            ]
        },
        {
            "url" : "https://www.baidu.com",
            "content" : [
                "123123",
                "123123",
                "123123",
                "123123",
                "123123"
            ]
        }
    ]
}

Описание поля:

• url — URL всплывающего окна при нажатии на уведомление, если всплывающее окно не требуется, содержимое поля пусто;

• content — содержание уведомления, порядок массива соответствует порядку заголовков таблицы.

Примечание:

• время ожидания — 10 секунд;

• помощник по уведомлению проверяет этот интерфейс каждые 20 секунд;

• если код возвращает 400, на главном экране отображается «Ошибка получения данных, пожалуйста, войдите снова», если интерфейс тайм-аут или интерфейс сбой, отображается «ошибка сервера приложения»;

• когда у пользователя нет необработанных дел, данные в поле данных возвращаются пустыми, код также должен возвращать 200;

• есть новое сообщение, будет системное уведомление;

• пока в списке дел пользователя есть данные, значок корзины системы будет мигать, и вам нужно реализовать обработку исчезновения дел без обработки самостоятельно.