Ctrlk
WebsitePlatform

HTML-файлы

Получить HTML файл

get

Получает HTML файл, хранящийся в Firebase, используя зашифрованный токен, передаваемый как параметр запроса.

Параметр запроса

  • token (string, обязательный): Зашифрованный токен, представляющий пользователя, сессию и имя файла. Этот токен используется для поиска и расшифровки соответствующего HTML файла.

Ответ (HTTP 200)

При успешном выполнении возвращает содержимое HTML файла с Content-Type text/html. html <html><body><h1>Пример HTML</h1></body></html>

Обработка ошибок

  • 400 Bad Request: Возвращается, если параметр token отсутствует или пуст.

  • 404 Not Found: Возвращается, если HTML файл не может быть получен (например, неверный токен или файл не найден).

  • 500 Internal Server Error: Возвращается при возникновении непредвиденной ошибки на сервере.

Безопасность

Для этого эндпоинта аутентификация не требуется.

Query parameters
tokenstringRequired

Зашифрованный токен для получения HTML файла.

Responses
200

HTML файл успешно получен.

application/json
stringOptional

Содержимое HTML файла.

Example: <html><body><h1>Пример HTML</h1></body></html>
get
/helper/html-files/

Загрузить HTML файл

post

Загружает HTML файл в Firebase для определенной сессии. Файл должен быть предоставлен как form-data с ключом html_file и иметь content type 'text/html'. Дополнительно, session_id должен быть включен в form-data для ассоциации файла с сессией.

Form Data

  • html_file (file, обязательный): HTML файл для загрузки. Только файлы с content type 'text/html' принимаются.

  • session_id (string, обязательный): ID сессии, связанный с загружаемым HTML файлом.

Ответ (HTTP 201)

При успешном выполнении возвращает JSON объект содержащий:

  • message (string): Сообщение подтверждающее успешную загрузку файла.

  • token (string): Зашифрованный токен, представляющий информацию о файле и сессии.

Обработка ошибок

  • 400 Bad Request: Возвращается, если обязательные поля отсутствуют (например, файл или ID сессии не предоставлены), если тип файла не 'text/html', или если UID администратора неверен.

  • 404 Not Found: Возвращается, если ID сессии не существует в Firestore.

  • 422 Unprocessable Entity: Возвращается, если обработка HTML файла (например, шифрование) не удалась.

  • 500 Internal Server Error: Возвращается при возникновении непредвиденной ошибки на сервере.

Безопасность

В заголовке Authorization должен быть предоставлен валидный API-KEY токен.

Authorizations
AuthorizationstringRequired

Укажите ваш Bearer-токен (Firebase auth) в формате: Bearer <токен>

Body
html_filestringRequired

HTML файл для загрузки. Должен иметь content type 'text/html'.

session_idstringRequired

ID сессии для ассоциации с загружаемым HTML файлом.

Responses
post
/helper/html-files/
PreviousОценка мобильностиNextПоддержка

Last updated

Was this helpful?