В качестве примера представлено содержание руководства программиста Система e-port дилер. Клиент-серверный протокол

Система «e-port дилер» предназначена для приема и проведения моментальных платежей при оплате услуг мобильной связи, доступа в Интернет и т. П. Центральный сервер системы принадлежит группе e-port, а пункт приема платежей может открыть любой желающий, установив у себя на компьютере (подключенном к Интернету) программу-клиент. Обмен данными между центральным сервером и программой-клиентом осуществляется по специальному протоколу. Протокол открытый, что позволяет различным организациям: банкам, розничным сетям, сетям платежных терминалов, осуществлять платежи непосредственно из собственных систем. Протокол разработан Группой e-port, а техническая документация «Философтом» по ее заказу.

ВВЕДЕНИЕ

Система e-port дилер: клиент-серверный протокол. Назначение и обзор возможностей

Задачи протокола

Основные преимущества использования протокола

1 Реализация протокола (шлюз)

1.1 Общие сведения

1.2 Структура приложения

2. Как работает шлюз

2.1 Регистрация и отчетность

2.1.1 Регистрация

2.1.2 Отчетность

2.2 Обмен данными с сервером

2.2.1 Структура пакета

2.2.2 Справочники

2.2.3 Порядок обмена пакетами

2.3 Цикл обработки операции

2.3.. Запрос операции

2.3.2 Очередь

2.3.3 Анализ ответа сервера

2.3.4 Нестандартные ситуации

3 Спецификация протокола

3.1 Структурные элементы пакета

3.2 Заголовок запроса

3.3 Заголовок ответа

3.4 Пополнение счета

3.5 Покупка PIN-кода

3.6 Прерывание процесса обработки операции

3.7 Транзакционные свойства операции

3.8 Запрос на проведение нескольких операций

3.9 Справочник

3.11 Статус операции

3.11.1 Примеры сообщений о статусе операций

3.11.2 Коды состояния находящихся в обработке или завершенных операций

3.11 Уведомления системы

4 ГЛОССАРИЙ

ПРИЛОЖЕНИЯ

Приложение 1. DTD XML-запроса и комментарий

DTD XML-запроса

Комментарий

Приложение А DTD XML-ответа

Приложение Б. Правила расчета суммовых полей

Приложение В Примеры запросов и ответов сервера

12.3 Руководство системного администратора

Руководство системного администратора составляют на основании ГОСТ 19.503-79

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

Руководство системного администратора — вспомогательный документ для прикладных программных продуктов и основной для серверных и системных, которые не имеют непосредственных пользователей.

В руководстве системного администратора должны быть изложены:

– назначение и область применения программы;

– состав программы, основные принципы ее функционирования;

– комплект поставки (если он не указан в отдельном документе);

– системные требования для программы или ее компонентов;

– предпочтительная очередность установки компонентов;

– процедура установки программы или каждого ее компонента;

– порядок обязательной первоначальной настройки программы;

– способы интеграции установленных копий компонентов между собой;

– интегрирование программы со сторонним ПО, например, с сервером БД;

– способы и периодичность контроля правильности работы программы;

– порядок текущего обслуживания работающих копий программы;