Архитектурное решение по задаче «Юридическая помощь»

1. МСБ

Архитектурное решение по задаче
«Юридическая помощь»
1

2. Описание REST API 1/2 (для партнера)

Сфера
Партнер
GET /oauth/authorize?.....
(Получа ем token -oauth 2.0)
Аутентификация
Authenticate
POST /oauth/token
(Получа ем access token - oauth 2.0)
Клиенты
Clients
POST /client
(Регистрация клиента)
PUT /client/{id}
(Обновление данных клиента)
Delete /client/{id}
(Уда лить данные клиента)
Обращения за юридическим сервисом
(Legal Service Requests)
POST /client/{id}/LegalCase
(Регистрация обращения)
GET /client/{id}/LegalCases
(Получи ть списо к обр ащений клиента)
DELETE /client/{id}/LegalCase/{id}
(Отменить обра щение)
GET /client/{id}/LegalCase/{id}
(Получи ть о бращени е клиента)
PUT /client/{id}/LegalCase/{id}
(Изменение ста туса обращения)
POST /client/{id}/LegalCase/{id}/comment
(Создание комментария)
Комментарии
(Comments)
Статусы:
Статусы:
Новый
Новое
Классифицировано
PUT /client/{id}/LegalCase/{id}/comment/{id}
(Изменение ста туса)
DELETE /client{id}/LegalCase/{id}/comment/{id}
Прочит ан
адресатом
Отказ клиента
(Уда лить коммента рий)
Согласовано
клиенто м
GET/client/{id}/LegalCase/{id}/comments
(Получи ть списо к комментариев по сделке)
В работе
GET/client/{id}/LegalCase/{id}/comments/count
(Получи ть количество коммента риев по сделке)
POST /client/{id}/LegalCase/comments/{id}/document
Обработано
(Вло жение документа)
GET/client/{id}/LegalCase/{id}/comments/{id}/documents
(Получи ть списо к документо в по сделке)
Документы
(Documents)
Закрыто
GET /client/{id}/LegalCase/{id}/comments/{id}/document/{id}
(Получи ть документ)
POST /client/{id}/LegalCase/{id}/estimation
(Оценка обращения)
Оценка
(Estimation)

3. Описание REST API 2/2 (для партнера)

Сфера
Партнер
GET /oauth/authorize?.....
Аутентификация
Authenticate
Клиенты
Clients
(Получа ем token -oauth 2.0)
Обращения (Legal Service Requests)
POST /oauth/token
Комментарии (Comments)
(Получа ем access token - oauth 2.0)
Документы (Documents)
События в юридическом сервисе
Legal Service Events
Типы:
Событие
POST/event
Обращение
изменило
статус
Добавлен
комментарий
Комментарий
изменил
статус
Добавлен
файл
(Создание события)
Обработчик событий

4. Описание выгружаемых событий

Event
Created
ППО24
Клиенты (Clients)
Обращения (Legal Service Requests)
Комментарии (Comments)
Документы (Documents)
description
Обращение создано
К обращению добавлен
CommentAdded
комментарий
DocumentAdded
К обращению добавлен документ
Обращение ожидает
PaymentConfirmationWaiting подтверждения суммы для оплаты
Сумма на оплату обращения
Accepted
акцептована
TypeChanged
Изменен тип обращения
TookToWork
Обращение взято в работу
Processed
Обработано сотрудником ППО
Closed
Закрыто
Статус ППО24
В работе (не оплачено)
Ожидание подтверждения
В работе (оплачено)
На закрытии
Закрыт

5. Маппинг статусов обращения на события и команды

Команды
Из Сферы получен
запрос
DELETE /client/{id}/
LegalCase/{id}
1. Из Сферы получен запрос
POST /client/{id}/LegalCase
Статусы
2. Сотрудник ППО 24 в
интерфейсе пользователя
создал обращение
В работе (не оплачен)
Из Сферы получен запрос
PUT /client/{id}/LegalCase/{id}.
В теле запроса получено
подтверждение суммы на оплату
Получив уведомление об
оплате обращения
сотрудник ППО24 в
карточке обращения
выбирает меню – взять
обращение в работу
Сотрудник ППО24 в
карточке обращения
указал тип и стоимость
обращения, выбрал статус
обращения - «Ожидает
подтверждения»
Ожидает
подтверждения
Из Сферы получен запрос
POST /client/{id}/LegalCase/{id}/
estimation.
Сотрудник ППО24 в
карточке обращения
указал решение по
обращению и выбирал
статус «На закрытии»
Сумма для оплаты
подтверждена
В работе, оплачено
На закрытии
Закрыт
События
Created
PaymentConfirmation
Waiting
Accepted
TookToWork
DocumentAdded
CommentAdded
AssessmentExpect
Closed

6. Описание запросов (1/4)

Запрос: Регистрация клиента
Запрос: Обновление данных клиента
Запрос: Удаление данных клиента
HTTP метод: POST
POST /client
HTTP метод: PUT
PUT /client/{id}
HTTP метод: DELETE
DELETE /client/{id}
Параметры запроса:
Параметры запроса:
{
“inn”: ИНН,
“ogrn”: ОГРН,
“organization”: наименование,
“tariff”: тариф,
}
Параметры запроса:
{
“inn”: ИНН,
“ogrn”: ОГРН,
“organization”: наименование,
“tariff”: тариф,
}
Описание:
Атрибут
Описание:
Тип
Описание:
Описание
Атрибут
Тип
Описание
inn
ИНН
inn
ИНН
ogrn
ОГРН
ogrn
ОГРН
organization
Наименование организации
organization
Наименование организации
tariff
Тариф
tariff
Тариф

7. Описание запросов (2/4)

Запрос: Создание обращения
HTTP метод: POST
POST /client/{id}/legalcase
Параметры запроса:
Запрос: Обновление обращения (кейс когда
обращение создано на стороне партнера и клиент с
ним ознакомился в ЛК)
HTTP метод: PUT
PUT /client/{id}/legalcase/{id}
{
“ogrn”: ОГРН,
“representative”: [
{
“surname”: Фамилия,
“name”: Имя ,
“patronymic”: Отчество
“telephone”: телефон
}
],
“text”: обращение
}
Атрибут
{
“comment”: содержание
комментария
}
{
“Read”: признак прочтения
обращения
}
Описание:
Тип
HTTP метод: POST
POST
/client/{id}/legalcase/{id}/comment
Параметры запроса:
Параметры запроса:
Описание:
Запрос: Добавление комментария к обращению
Описание:
Описание
Атрибут
Тип
Описание
Атрибут
ogrn
ОГРН
Read
Boolean
comment
Representative
Данные представителя
Признак
прочтения
обращения
Surname
Фамилия
Name
Имя
Patronymic
Отчество
Telephone
Телефон
deal
Данные обращения
Тип
Описание
комментарий
Запрос позволяет добавить комментарий к
существующему обращению

8. Описание запросов (3/4)

Запрос: Акцепт обращения
HTTP метод: PUT
PUT /client/{id}/legalcase/{id}
Параметры запроса:
{
“Accept”: признак акцепта
обращения
}
Запрос: Удаление сделки. Кейсы: клиент отказался от
обращения (высокая стоимость не типового
обращения), у клиента не достаточно ДС обработки
обращения
Запрос: Обновление комментария. Кейс:
комментарий создан на стороне партнера,
необходимо уведомлять партнёра о прочтении
комментария клиентом
HTTP метод: DELETE
DELETE /client/{id}/legalcase/{id}
HTTP метод: PUT
PUT /client/{id}/legalcase/{id}/comment/{id}
Параметры запроса:
Параметры запроса:
{
“read”: признак прочтения
комментария
}
Описание:
Описание:
Атрибут
Тип
Описание
Accept
Boolean
Признак акцепта
обращения
Акцепт клиента инициирует обработку
обращения на стороне ППО24 и выгрузку
события изменения обращения в БКС
Описание:
Атрибут
Тип
Описание
read
Boolean
Признак
прочтения
комментария

9. Описание запросов (4/4)

Запрос: Удаление комментария. Должна
отрабатывать логика на стороне партнера: если
на комментарий просмотрен сотрудником
ППО24, сотрудник ответил на комментарий, его
удалить нельзя
Запрос: Добавление документа
Запрос: Получить файл документа
HTTP метод: POST
POST /client/{id}/legalcase/{id}/comments/{id}/document
HTTP метод: GET
GET /client/{id}/legalcase/{id}/comments/{id}/document/{id}
Параметры запроса:
Параметры запроса:
HTTP метод: DELETE
DELETE /client/{id}/legalcase/{id}/comment/{id}
Параметры запроса:
Описание:
Параметры запроса:
Параметры запроса:
Описание:
Описание: