Commit d3d43a96 authored by Alina Habibulina's avatar Alina Habibulina

Update README.md

parent e16e3fd5
# Шаблон веб-приложения с кастомным REST API
В приложении приведен пример создания кастомного REST API на Java.
Кастомный импорт записей реестра.
Данное приложение можно разместить в сервере приложений JBoss, который
устанавливается вместе с Synergy.
......@@ -13,45 +12,17 @@
$ ./gradlew war
```
Собранный `synergy-api-proxy-1.0.war` необходимо поместить
в `/opt/synergy/jboss/standalone/deployments`
## Конфигурация
Приложение читает конфигурационный файл `synergy-api-proxy.properties`
в директории `/opt/synergy/jboss/standalone/configuration/external`.
1) Развернуть установочный архив <i>import.war</i><br>
2) Выполнить на сервере команду <i># mkdir /tmp/crm-import</i><br>
3) Выполнить на сервере команду <i># chmod 777 -R /tmp/crm-import</i>;<br>
4) Перейти по адресу <i>{ip}:8080/import</i>.<br>
Параметры конфигурации:
```properties
# Приведенные ниже значения параметров являются значениями по-умолчанию
# Адрес Synergy для доступа к REST API
synergy.url=http://127.0.0.1:8080/Synergy
# Логин пользователя от имени которого будет выполняться запрос к REST API Synergy
synergy.user.login=1
# Пароль пользователя от имени которого будет выполняться запрос к REST API Synergy
synergy.user.password=1
```
## Описание:
## REST API
Endpoint: `http[s]://host:[port]/sap`
1. Метод получения изображения [`GET`]`/proxy/unsecured/image`
```
/**
* Обертка над методом /rest/api/storage/file/get
* Не требует авторизации.
* Обращение к REST API Synergy осуществляется от имени пользователя,
* указанного в настройках (параметры synergy.user.login и synergy.user.password)
*
* @param identifier идентификатор файла в хранилище
* @return inline изображение. Если запрошенный файл не является изображением, то вернется ошибка.
*/
```
Пример запроса:
`http://127.0.0.1:8080/sap/proxy/unsecured/image?identifier=29130a30-42cf-451a-98e8-6f6827d3751b`
\ No newline at end of file
Импорт работает со следующими компонентами формы:
- текстовые однострочные и многострочные поля
- числовые поля
- дата/время
- справочники (выпадающий список, выбор вариантов, переключатель вариантов)
- ссылка на реестр
\ No newline at end of file
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment