API Bereich

Willkommen im API-Bereich von Flixshot!
Baue dir hier einen API-Link für deine Anwendung oder entnehme Informationen zu möglichen Parametern.

Wenn du Fragen hast oder Hilfe benötigst, melde dich bei uns.

Sofern du die volle API verwenden möchtest, musst du angemeldet sein.
Dir wird hier dann dein Token angezeigt.
API Link Generator

Lass uns deinen Link gemeinsam bauen. Fülle einfach die Felder aus. Am Ende bekommst du deinen persönlichen Link.

URL:
Link der Webseite, welche du fotografieren möchtest.


Wartezeit:
Wie lange soll auf der Webseite gewartet werden, bis der Shot erzeugt werden soll?


Breite:
Welche Pixelbreite soll der Shot haben?


Höhe:
Welche Höhe soll der Shot haben?
Wichtig: in manchen Fällen führt ein "Fullsize" nicht zum gewünschten Ergebnis.
In diesem Fall dann einfach auf "Individual" umstellen und die Höhe auf z.B. 4096 Pixel setzen.


Ausgabeformat:
Möchtest du als Ausgabe direkt das Bild oder lieber einen JSON-Container mit Pfad und Zusatzinformationen?


LAZY:
Wenn du als Ausgabeformat den JSON-Container gewählt hast, kannst du mit "LAZY" bestimmen, ob du sofort nach Anfrage den Container angezeigt bekommen möchtest oder lieber wartest bis der Shot abgeschlossen wurde.


Dein persönlicher Link:

Parameter

url*
Verfügbar in GAST | Erweiterte API | Gesamte API

POST | GET

URL zur Webseite, welche fotografiert werden soll.
Beispiel: https://www.wikipedia.com

token
Verfügbar in Erweiterte API | Gesamte API

POST | GET

Verknüpfung an das Kundenkonto.
Ohne Token stehen nur GAST-Funktionen zur Verfügung.

output ("data" / "image" - Standard: "data")
Verfügbar in GAST | Erweiterte API | Gesamte API

POST | GET

Standardmäßig wird das angeforderte Bild als JSON Container ausgegeben.
Sofern man jedoch direkt das Bild laden möchte, gibt man den "output"-Parameter mit Wert: "image" mit.

width (Standard: s. Beschreibung | Max: 4096)
Verfügbar in GAST | Erweiterte API | Gesamte API

POST | GET

Es ist möglich den Viewport des Browsers mitzugeben.
z.B. wie breit der Screenshot werden soll.
Die Angaben verstehen sich als Pixel Werte.

Breite für die GAST-API | Standard: 1024 | Max: 1024
Breite für die KOSTENLOSE-API | Standard: 1280 | Max: 1280
Breite für die GESAMTE-API | Standard: 1990 | Max: 4096

height (Standard: s. Beschreibung | max: "fullsize")
Verfügbar in GAST | Erweiterte API | Gesamte API

POST | GET

Es ist möglich den Viewport des Browsers mitzugeben.
z.B. wie hoch der Screenshot werden soll.
Die Angaben verstehen sich als Pixel Werte.

Höhe für die GAST-API | Standard: 768 | Max: 768
Höhe für die KOSTENLOSE-API | Standard: 768 | Max: "fullsize"
Höhe für die GESAMTE-API | Standard: 1000 | Max: "fullsize"

delay (Standard: 1000 | max: 1000 / 3000 / 30000)
Verfügbar in GAST | Erweiterte API | Gesamte API

POST | GET

Nachdem der Browser die Seite aufgerufen hat, wartet dieser mindestens 1 Sekunde -> 1000 Millisekunden.
Maximale Wartezeit für die GAST-API | Standard: 1000 | Max: 1000
Maximale Wartezeit für die KOSTENLOSE-API | Standard: 1000 | Max: 3000
Maximale Wartezeit für die GESAMTE-API | Standard: 1000 | Max: 30000

lazy (Standard: 0)
Verfügbar in Erweiterte API | Gesamte API

POST | GET

Wenn nicht auf das Bild gewartet, sondern direkt der Bild-Pfad geliefert werden soll, setze diesen Parameter mit Wert 1 ein.
Wichtig: Nur im OUTPUT Parameter "data" verfügbar.

css (Standard: "" | ONLY POST)
Verfügbar in Erweiterte API | Gesamte API

POST

Wenn auf der Webseite unerwünschte Elemente wie Cookie-Banner etc. vorliegen, können diese mit CSS ausgeblendet werden.

failureImage (Standard: "https://app.flixshot.net/fileadmin/sorry.png")
Verfügbar in Erweiterte API | Gesamte API

POST | GET

Manchmal kann es vorkommen, dass kein Screenshot gemacht werden kann.
In diesem Fall senden wir das folgende Bild: Link zum Screenshot
Mit der Eingabe dieses Parameters, kann der fehlerhafte Screenshot mit einem beliebigen anderen ausgetauscht werden.

* = Pflichtangabe
Übersicht über mögliche Fehlermeldungen:

  • "Token not valid!" => Du hast keinen gültigen Token hinterlegt. Kopiere dir oben deinen API Token.
  • "No more credits available! please upgrade to the next higher package!" => Du hast für diesen Monat alle Flixshots ausgeschöpft. Upgrade dein Paket oder warte bis zum nächsten Monat.
  • "No url parameter given" => Du hast vergessen uns die Webseite mitzuteilen, welche wir fotografieren sollen.
  • "Url is not valid - maybe protocol missing?" => Prüfe bitte ob dem Link z.B. das Protokoll "http" oder "https" fehlt.