Техническая документация

Понятия и определения

Работа с сервисом

Загрузка информации в сервис

Для осуществления загрузки данных в сервис prov.by необходимо отправить POST запрос на адрес https://prov.by/api/addDoc.
В запросе должны присутствовать следующие заголовки (headers):

Тело запроса должно содержать данные, которые будут загружены в сервис.

При получении запроса на загрузку информации, сервис проверяет валидность Персонального ключа клиента, отсутствие IP адреса, с которого пришел запрос, в базе заблокированных адресов и разрешение на использование сервиса клиентом. Если проверка пройдена успешно, то сервис шифрует тело запроса сгенерированным паролем и сохраняет информацию в своей базе данных.

ВНИМАНИЕ! В сервисе может находится только один документ с уникальным номером и ключом клиента! Это значит, что у одного и того-же клиента не может быть двух документов с одинаковым номером.

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

При успешном сохранении данных, в ответ на POST запрос, сервис возвращает JSON строку, содержащую сгенерированный пароль для документа, пароль для удаления документа, и, при необходимости отправляет Номер документа и Пароль документа на указанный мобильный телефон в виде СМС сообщения. Отправитель сообщения PROV.BY.

Выгрузка информации из сервиса

Для осуществления выгрузки информации из сервиса prov.by необходимо отправить POST запрос на адрес https://prov.by/api/GetDoc. В запросе должны присутствовать следующие заголовки (headers):

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

Удаление информации из сервиса

Для осуществления удаления информации из сервиса prov.by необходимо отправить POST запрос на адрес https://prov.by/api/DelDoc. В запросе должны присутствовать следующие заголовки (headers):

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

Блокирование IP адреса

Блокирование IP адреса производится при условии попыток подбора Пароля документа или иных действиях, которые можно расценить как попытку несанкционированного доступа к данным.
Для разблокировки IP адреса отправьте сообщение посредством формы обратной связи на странице "Контакты", с обязательным указанием заблокированного IP адреса.