HTML-Dateien

HTML-Datei abrufen

get

Ruft eine in Firebase gespeicherte HTML-Datei ab, indem ein verschlüsselter Token als Abfrageparameter übergeben wird.

Abfrageparameter

  • token (string, erforderlich): Verschlüsselter Token, der den Benutzer, die Sitzung und den Dateinamen repräsentiert. Dieser Token wird verwendet, um die entsprechende HTML-Datei zu lokalisieren und zu entschlüsseln.

Antwort (HTTP 200)

Bei Erfolg wird der Inhalt der HTML-Datei mit einem Content-Type von text/html zurückgegeben.

<html><body><h1>Beispiel HTML</h1></body></html>

Fehlerbehandlung

  • 400 Bad Request: Wird zurückgegeben, wenn der token-Abfrageparameter fehlt oder leer ist.
  • 404 Not Found: Wird zurückgegeben, wenn die HTML-Datei nicht abgerufen werden kann (z. B. ungültiger Token oder Datei nicht gefunden).
  • 500 Internal Server Error: Wird zurückgegeben, wenn ein unerwarteter Fehler auf dem Server auftritt.

Sicherheit

Für diesen Endpunkt ist keine Authentifizierung erforderlich.

Abfrageparameter
tokenstringErforderlich

Verschlüsselter Token, der zur Abfrage der HTML-Datei verwendet wird.

Antworten
200

HTML-Datei erfolgreich abgerufen.

application/json
stringOptional

Der Inhalt der HTML-Datei.

Example: <html><body><h1>Beispiel HTML</h1></body></html>
get
/helper/html-files/

HTML-Datei hochladen

post

Lädt eine HTML-Datei für eine bestimmte Sitzung in Firebase hoch. Die Datei muss als Form-Daten mit einem Schlüssel html_file bereitgestellt werden und einen Content-Type von 'text/html' haben. Zusätzlich muss die session_id in den Form-Daten enthalten sein, um die Datei mit einer Sitzung zu verknüpfen.

Form-Daten

  • html_file (file, erforderlich): Die hochzuladende HTML-Datei. Es werden nur Dateien mit dem Content-Type 'text/html' akzeptiert.
  • session_id (string, erforderlich): Die Sitzungs-ID, die mit der hochgeladenen HTML-Datei verknüpft ist.

Antwort (HTTP 201)

Bei Erfolg wird ein JSON-Objekt zurückgegeben, das Folgendes enthält:

  • message (string): Eine Bestätigungsmeldung, die anzeigt, dass die Datei erfolgreich hochgeladen wurde.
  • token (string): Ein verschlüsselter Token, der die Datei- und Sitzungsinformationen repräsentiert.

Fehlerbehandlung

  • 400 Bad Request: Wird zurückgegeben, wenn erforderliche Felder fehlen (z. B. keine Datei oder Sitzungs-ID angegeben), wenn der Dateityp nicht 'text/html' ist oder wenn die Admin-UID ungültig ist.
  • 422 Unprocessable Entity: Wird zurückgegeben, wenn die Verarbeitung der HTML-Datei (z. B. Verschlüsselung) fehlschlägt.
  • 500 Internal Server Error: Wird zurückgegeben, wenn ein unerwarteter Fehler auf dem Server auftritt.

Sicherheit

Ein gültiger API-KEY-Token muss im Authorization-Header bereitgestellt werden.

Autorisierungen
AuthorizationstringErforderlich

Geben Sie Ihren API-KEY-Token im Format ein: API-KEY

Body
html_filestringErforderlich

Die hochzuladende HTML-Datei. Muss den Content-Type 'text/html' haben.

session_idstringErforderlich

Die Sitzungs-ID, die mit der hochgeladenen HTML-Datei verknüpft ist.

Antworten
post
/helper/html-files/

War das hilfreich?