Документация, содержащая описание функциональных характеристик программного обеспечения и информацию, необходимую для установки и эксплуатации программного обеспечения Appruvo

Оглавление

• Руководство пользователя
• Назначение
• Формат входящих заявок
• Инструкция по работе с заявками

Руководство пользователя

Назначение документа

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

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

• Загрузку и установку программных продуктов;
• Взаимодействие с интерфейсом программного обеспечения.

Назначение программного обеспечения

ПО предназначено для поставки клиентов для автодилеров

Уровень подготовки пользователей

Пользователь ПО должен иметь навык работы с API протоколами.

Общее описание функциональных характеристик Appruvo

Appruvo реализовано на основе архитектуры SOA (Service-Oriented Architecture). В качестве сервера используется веб-сервер Nginx. Клиентская часть представлена в виде интерфейса, взаимодействующего с сервисами через API, и доступна по протоколу HTTPS и использованием REST, что позволяет использовать её на любых устройствах согласно требованиям ниже.

Посредством ПО реализуются следующие функции:

1. Получение заявок по интеграции от партнеров
2. Обработка документов

Программные и аппаратные требования

Для работы с ПО необходимо чтоб ваша система могла отправлять POST запросы к серверу.

Авторизация в SAAS-сервисе (для конечного пользователя)

ПО распространяется в виде интернет-сервиса, специальные действия по установке ПО на стороне пользователя не требуются. Конечный пользователь осуществляет взаимодействие с сервисом через API, авторизация осуществляется путем отправки токена в заголовке HTTP запроса. Authorization: Bearer {{token}} Токен получается в POST запросе ​/user​/auth​/token с полями name и password.

Инструкция по эксплуатации ПО (инструкция для конечного пользователя):

1. Получаем токен авторизации по запросу /user​/auth​/token поля name и password
2. В ответ получаем json с токеном доступа

{ «token_type»: «Bearer», «access_token»: «…………….», «expires_in»: 300, «refresh_token»: «……………..», «refresh_expires_in»: 1800 }

3. Получаем заявку от партнера через метод POST​/api​/credit​/notify с заголовком Authorization: Bearer {{token}}. Параметры для получения заявки: id, status и url

Параметр	Название	Формат	Пример
id	id во внешней системе	string	d4b94965-5038-4921-85a2-a746535e602b
status	Текущий статус	string	Draft
url	Внешний URL-адрес для загрузки	string	https://some.ru/message/id

4. Успешный ответ

{

«id»:»»,

«externalId»: «»

}