Разработчикам

POST/v3/delete_encrypted_file/{file_id}

Удаление неиспользуемой ссылки на загруженный файл

Удалите локальную запись ссылки на загруженный файл, не путая эту операцию с удалением идентификационных данных или полным стиранием документа.

На этой странице
  1. Выберите неиспользуемую ссылку на загруженный файл
  2. Отправляйте запрос на удаление осознанно
  3. Учитывайте результат и его ограничения
  4. Удаление ссылки не означает полного стирания данных

Выберите неиспользуемую ссылку на загруженный файл

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

Получите внешний идентификатор файла из исходного источника: ответ на загрузку или список доступных загрузок. Обработчик сначала ищет этот идентификатор в рамках вашей учётной записи, а если поиск не даёт результата, использует устаревший способ поиска по идентификатору провайдера. Новые интеграции должны использовать внешнюю ссылку точно в том виде, в котором она была возвращена. Тело запроса не требуется.

Отправляйте запрос на удаление осознанно

Используйте активированную учётную запись API MultiTEL через HTTPS с настроенными для неё учётными данными и ограничениями по IP-адресам. Используйте POST, чтобы ваше приложение обрабатывало эту операцию как осознанное изменение:

curl --silent --show-error --request POST \
  --user "$API_USER:$API_PASSWORD" \
  https://api.multitel.net/v3/delete_encrypted_file/0123456789abcdef0123456789abcdef

Текущий обработчик не ограничивает метод HTTP: запрос GET тоже может привести к удалению. Не используйте этот URL как обычную ссылку для перехода, адрес изображения, закладку, адрес для предварительного просмотра или предварительной загрузки. Требуйте явного действия для удаления в вашем приложении и не повторяйте запрос автоматически.

Учитывайте результат и его ограничения

Проверяйте как результат HTTP, так и поле status.code в JSON. Обычный ответ при успешном выполнении выглядит так:

{
  "status": {"code": 200, "msg": "Success"},
  "response": []
}

Код API 404 с сообщением Failed, Not found означает, что ни один из двух способов поиска не нашёл соответствующую ссылку для этой учётной записи. Поэтому повторный запрос на удаление может вернуть 404. Начальные и конечные пробелы в значении параметра пути удаляются. Здесь не проверяется, что срок действия ссылки ещё не истёк или что она не используется на другом этапе, поэтому перед удалением убедитесь, что это допустимо в вашем процессе.

Обработчик сообщает об успехе после попытки удаления из базы данных, не проверяя, удалось ли удаление. Рассматривайте ответ как сообщённый результат, а не как независимое доказательство стирания данных. Если ссылка, созданная через API, с ещё не истёкшим сроком действия отображалась в get_encrypted_files, этот список может помочь проверить, отображается ли она по-прежнему, однако отсутствие в списке может также означать истечение срока действия.

Удаление ссылки не означает полного стирания данных

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

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