Меню
Открытый API-интерфейс для возможности загрузки своих объявлений и новостей в раздел «Новости компании» стандартного мобильного приложения «ЖКХ: Личный кабинет»

Открытый API-интерфейс для возможности загрузки своих объявлений и новостей в раздел «Новости компании» стандартного мобильного приложения «ЖКХ: Личный кабинет»

Данный API-интерфейс позволяет загружать УК, ТСЖ и другим организациям ЖКХ свои новости в мобильное приложение ЖКХ: Личный кабинет. При этом можно задать режим отображения новостей:

  1. Только новости организации ЖКХ.

  2. Новости организации ЖКХ и общие новости с сайта гарант.

В мобильном приложении «ЖКХ:Личный кабинет» новости отображаются следующим образом:

Новости в Личном кабинете


В левой части для каждой новости отображается картинка, которая случайным образом выбирается из списка заранее заготовленных картинок на сервере. Данное API позволяет указать вместо стандартной картинки свое изображение. Рассмотрим все возможные запросы.


Запрос на получение токена

POST https://ws-tszh.vdgb-soft.ru/api/clients/news/token
{
login=[имя пользователя]
pass=[пароль]
email=[электронная почта]
}


Параметры:

login: логин – имя пользователя, совпадает с указанным именем пользователя при регистрации организации из 1С.

pass: пароль, совпадает с указанным паролем при регистрации организации из 1С.

email: электронная почта, совпадает с указанной электронной почтой при регистрации организации из 1С.


Ответ success: {"success":true, “data”: {[токен]}}

Ответ fail: {"error":true,"data":{ "code": [код ошибки], "message": [сообщение об ошибке] } }


Запрос на задание настроек отображения новостей в мобильном приложении

POST https://ws-tszh.vdgb-soft.ru/api/clients/news/setting
{
token=[токен]
inn=[ИНН]
mode=[режим отображения новостей в мобильном приложении; возможны следующие значения:
1 – новости компании и общие новости сферы ЖКХ (с сайта Гарант),
0 - только новости компании,
-1 (или другие значения, отличные от 1 и 0) – только общие новости сферы ЖКХ (с сайта Гарант)]
}


Параметры:

token: токен, полученный при выполнении запроса https://ws-tszh.vdgb-soft.ru/api/clients/news/token.

inn: ИНН организации.

mode: режим отображения новостей в мобильном приложении необязательный параметр, по умолчанию равно 0.


Ответ success: {"success":true, “data”: {}}

Ответ fail: {"error":true,"data":{ "code": [код ошибки], "message": [сообщение об ошибке] } }


Важный момент:

Данный запрос не обязательный. При создании первой новости, автоматически задается режим отображения новостей в мобильном приложении, если ранее не был выполнен запрос на задание настроек.


Запрос на создание новости

POST https://ws-tszh.vdgb-soft.ru/api/clients/news/create
{
token=[токен]
inn=[ИНН]
title=[заголовок]
annotation=[аннотация]
content=[содержимое новости]
date=[дата новости, в виде строки, например 2018-06-05]
image_url=[ссылка на картинку с другого сайта]
mode=[видимость новостей в мобильном приложении: 1 или on - новость отображается в мобильном приложении, 0 – новость не отображается в мобильном приложении]
}


или


POST https://ws-tszh.vdgb-soft.ru/api/clients/news/create
{
token=[токен]
inn=[ИНН]
title=[заголовок]
annotation=[аннотация]
content=[содержимое новости]
date=[дата новости, в виде строки, например 2018-06-05]
'поле-запроса'=[название поля загрузки файла с компьютера с атрибутом в веб-форме]
mode=[видимость новостей в мобильном приложении: 1 или on - новость отображается в мобильном приложении, 0 – новость не отображается в мобильном приложении]
}


Параметры:

token: токен, полученный при выполнении запроса https://ws-tszh.vdgb-soft.ru/api/clients/news/token.

inn: ИНН организации.

title: заголовок новости.

annotation: краткая аннотация новости.

content: содержимое новости.

date: дата новости, необязательный параметр, по умолчанию текущая дата добавления новости.

mode: видимость новости в мобильном приложении, необязательный параметр, по умолчанию равно отобразить новость.

image_url: ссылка на картинку, необязательный параметр, по умолчанию равно пустой строке.

<поле_запроса>: загруженный файл из компьютера, необязательный параметр. Данный параметр используется только в том случае, когда значение параметра image_url не установлено или равно пустой строке.


Ответ success: {"success":true, “data”: {“id”: [идентификатор новости]}}

Ответ fail: {"error":true,"data":{ "code": [код ошибки], "message": [сообщение об ошибке] } }


Важный момент:

  1. После выполнения запроса на создание новости для возможности впоследствии редактировании новости вам необходимо сохранить идентификатор новости, полученный из ответа на данный запрос.

  2. При создании первой новости, автоматически задается режим отображения новостей в мобильном приложении, если ранее не был выполнен запрос на задание настроек (https://ws-tszh.vdgb-soft.ru/api/clients/news/setting)


Примеры html-формы запроса на создание новости

Пример № 1 Форма создания новости с загрузкой изображения по ссылке

<form method="POST" action="https://ws-tszh.vdgb-soft.ru/api/clients/news/create" enctype="multipart/form-data">
  <table>
    <tr>
      <td><input type="hidden" name="token" value="<токен>"/><td>
    </tr>

    <tr>
      <td><input type="hidden" name="inn" value="<ИНН организации>"/><td>
    </tr>
    <tr>
      <td><h4>Заголовок<h4></td>
      <td><input name="title" value=""/></td>
    </tr>
    <tr>
      <td><h4>Аннотация<h4></td>
      <td><input name="annotation" value=""/></td>
    </tr>
    <tr>
       <td><h4>Текст<h4></td>
      <td><textarea name="content" cols="64" rows="20"></textarea></td>
    </tr>
    <tr>
      <td><h4>Дата<h4></td>
      <td><input id="date" name="date"/></td>
    </tr>
    <tr>
      <td><h4>Ссылка на изображение<h4></td>
      <td><input id="image_url" name="image_url"/></td>
    </tr>
    <tr>
      <td><h4>Видимость новости<h4></td>
      <td><input type="checkbox" name="mode" checked="true"/></td>
    </tr>
    <tr>
      <td><input type="submit" name="send" value="Отправить"></td>
    </tr>
  </table>
</form>

Пример № 2 Форма создания новости с загрузкой изображения из компьютера

<form method="POST" action="https://ws-tszh.vdgb-soft.ru/api/clients/news/create" enctype="multipart/form-data">
  <table>
    <tr>
      <td><input type="hidden" name="token" value="<токен>"/><td>
    </tr>

    <tr>
      <td><input type="hidden" name="inn" value="<ИНН организации>"/><td>
    </tr>
    <tr>
      <td><h4>Заголовок<h4></td>
      <td><input name="title" value=""/></td>
    </tr>
    <tr>
      <td><h4>Аннотация<h4></td>
      <td><input name="annotation" value=""/></td>
    </tr>
    <tr>
      <td><h4>Текст<h4></td>
      <td><textarea name="content" cols="64" rows="20"></textarea></td>
    </tr>
    <tr>
      <td><h4>Дата<h4></td>
      <td><input id="date" name="date"/></td>
    </tr>
    <tr>
      <td><h4>Загрузить изображение<h4></td>
      <td><input type="file" accept="image/*" name="image_file"/></td>
    </tr>
    <tr>
      <td><h4>Видимость новости<h4></td>
      <td><input type="checkbox" name="mode" checked="true"/></td>
    </tr>
    <tr>
      <td><input type="submit" name="send" value="Отправить"></td>
    </tr>
  </table>
</form>



Запрос на изменение новости

POST https://ws-tszh.vdgb-soft.ru/api/clients/news/update
{
token=[токен]
id=[идентификатор новости]
inn=[ИНН]
title=[заголовок]
annotation=[аннотация]
content=[содержимое новости]
date=[дата новости, в виде строки, например 2018-06-05]
image_url=[ссылка на картинку с другого сайта]
mode=[видимость новостей в мобильном приложении: 1 или on - новость отображается в мобильном приложении, 0 - новость не отображается в мобильном приложении]
}


или


POST https://ws-tszh.vdgb-soft.ru/api/clients/news/update
{
token=[токен]
id=[идентификатор новости]
inn=[ИНН]
title=[заголовок]
annotation=[аннотация]
content=[содержимое новости]
date=[дата новости, в виде строки, например 2018-06-05]
'поле-запроса'=[название поля загрузки файла с компьютера с атрибутом в веб-форме]
mode=[видимость новостей в мобильном приложении: 1 или on - новость отображается в мобильном приложении, 0 – новость не отображается в мобильном приложении]
}


Параметры:

token: токен, полученный при выполнении запроса https://ws-tszh.vdgb-soft.ru/api/clients/news/token.

id: идентификатор новости, полученный из ответа на запрос создания новости.

inn: ИНН организации.

title: заголовок новости.

annotation: краткая аннотация новости.

content: содержимое новости.

date: дата новости, необязательный параметр, по умолчанию не установлено.

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

image_url: ссылка на картинку, необязательный параметр, по умолчанию равно пустой строке.

<поле_запроса>: загруженный файл из компьютера, необязательный параметр. Данный параметр используется только в том случае, когда значение параметра image_url не установлено или равно пустой строке.


Ответ success: {"success":true, “data”: {“id”:[идентификатор новости]}}

Ответ fail: {"error":true,"data":{ "code": [код ошибки], "message": [сообщение об ошибке] } }


Важные моменты:

  1. Чтобы удалить свою собственную картинку (и использовать стандартную картинку) с новости, необходимо в параметре image_url POST-запроса указать либо значение del, либо значение delete, либо значение remove.

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


Пример html-формы запроса на изменение новости

Пример № 1 Форма изменения новости с загрузкой изображения по ссылке

<form method="POST" action="https://ws-tszh.vdgb-soft.ru/api/clients/news/update" enctype="multipart/form-data">
  <table>
    <tr>
      <td><input type="hidden" name="token" value="<токен>"/><td>
    </tr>

    <tr>
      <td><input type="hidden" name="inn" value="<ИНН организации>"/><td>
    </tr>
    <tr>
      <td><h4>Идентификатор новости<h4></td>
      <td><input name="id"/></td>
    </tr>
    <tr>
      <td><h4>Заголовок<h4></td>
      <td><input name="title" value=""/></td>
    </tr>
    <tr>
      <td><h4>Аннотация<h4></td>
      <td><input name="annotation" value=""/></td>
    </tr>
    <tr>
      <td><h4>Текст<h4></td>
      <td><textarea name="content" cols="64" rows="20"></textarea></td>
    </tr>
    <tr>
      <td><h4>Дата<h4></td>
      <td><input id="date" name="date"/></td>
    </tr>
    <tr>
      <td><h4>Ссылка на изображение<h4></td>
      <td><input id="image_url" name="image_url"/></td>
    </tr>
    <tr>
      <td><h4>Видимость новости<h4></td>
      <td><input type="checkbox" name="mode" checked="true"/></td>
    </tr>
    <tr>
      <td><input type="submit" name="send" value="Отправить"></td>
    </tr>
  </table>
</form>

Пример № 2 Форма изменения новости с загрузкой изображения из компьютера

<form method="POST" action="https://ws-tszh.vdgb-soft.ru/api/clients/news/update" enctype="multipart/form-data">
  <table>
    <tr>
      <td><input type="hidden" name="token" value="<токен>"/><td>
    </tr>

    <tr>
      <td><input type="hidden" name="inn" value="<ИНН организации>"/><td>
    </tr>
    <tr>
      <td><h4>Идентификатор новости<h4></td>
      <td><input name="id"/></td>
    </tr>
    <tr>
      <td><h4>Заголовок<h4></td>
      <td><input name="title" value=""/></td>
    </tr>
    <tr>
      <td><h4>Аннотация<h4></td>
      <td><input name="annotation" value=""/></td>
    </tr>
    <tr>
      <td><h4>Текст<h4></td>
      <td><textarea name="content" cols="64" rows="20"></textarea></td>
    </tr>
    <tr>
      <td><h4>Дата<h4></td>
  <td><input id="date" name="date"/></td>
    </tr>
    <tr>
      <td><h4>Загрузить изображение<h4></td>
      <td><input type="file" accept="image/*" name="image_file"/></td>
    </tr>
    <tr>
      <td><h4>Видимость новости<h4></td>
      <td><input type="checkbox" name="mode" checked="true"/></td>
    </tr>
    <tr>
        <td><input type="submit" name="send" value="Отправить"></td>
    </tr>
  </table>
</form>


Запрос на удаление новости

POST https://ws-tszh.vdgb-soft.ru/api/clients/news/remove
{
token=[токен]
inn=[ИНН]
id=[идентификатор новости]
del=[режим удаления: 1 или on – удалить новость с базы данных, 0 – сделать невидимой для мобильного приложения]
}


Параметры:

token: токен, полученный при выполнении запроса https://ws-tszh.vdgb-soft.ru/api/clients/news/token.

inn: ИНН организации.

id: идентификатор новости, полученный из ответа на запрос создания новости.

del: режим удаления новостей: 1 или on – удалить новость насовсем, 0 – скрыть новость, по умолчанию скрыть новость.


Ответ success: {"success":true, “data”: {“id”:[идентификатор новости]}}

Ответ fail: {"error":true,"data":{ "code": [код ошибки], "message": [сообщение об ошибке] } }


Назад


Материалы по теме: