Transloadit

Liste der Templates abrufen

GEThttps://api2.transloadit.com/templates?signature={SIGNATURE}&params={PARAMS}

GET-Abfragekomponenten

  • Die Übergabe von signature ist erforderlich. Weitere Informationen finden Sie unter Signature Authentication.
  • Die Übergabe von params ist erforderlich. Das Feld sollte ein JSON-codiertes Objekt mit den in der folgenden Tabelle aufgeführten Schlüsseln enthalten.

Unterstützte Schlüssel im Feld params

  • auth — erforderlich

    object

    Enthält mindestens den Auth Key von Transloadit in der Eigenschaft key.

    Wenn Sie Signature Authentication aktivieren, müssen Sie außerdem in der Eigenschaft expires ein Ablaufdatum für die Anfrage festlegen:

    {
  "key": "23c96d084c744219a2ce156772ec3211",
  "expires": "2009-08-28T01:02:03.000Z"
}

    Wir empfehlen dringend, die Eigenschaft nonce einzuschließen – einen zufällig generierten, pro Anfrage eindeutigen Wert. Dieser verhindert eine doppelte Verarbeitung bei Retries, kann die Fehlerdiagnose erleichtern und vermeidet Angriffsvektoren wie die Wiederverwendung von Signaturschlüsseln:

    {
  // …
  "nonce": "04ac6cb6-df43-41fb-a7fd-e5dd711a64e1"
}

    Die Eigenschaft referer ist ein regulärer Ausdruck, der mit dem HTTP-Referrer dieses Uploads abgeglichen wird, beispielsweise "example\.org". Geben Sie diesen Schlüssel an, um sicherzustellen, dass Uploads nur von Ihrer Domain stammen.

    Uploads ohne Referrer werden immer akzeptiert, da Referrer in einigen Browsern deaktiviert sind. Daher ist dies nur für wenige Anwendungsfälle nützlich. Einzelheiten zu regulären Ausdrücken finden Sie in der RegExp-Dokumentation von Mozilla.

    Mit der Eigenschaft max_size können Sie eine maximale Größe in Bytes für einen Upload festlegen, beispielsweise 1048576 (1 MB). Geben Sie diese an, um zu verhindern, dass Benutzer übermäßig große Dateien hochladen. Die Dateigröße wird geprüft, sobald der Upload beginnt. Überschreitet sie die maximale Größe, wird der gesamte Upload-Vorgang abgebrochen und die Assembly schlägt fehl – selbst wenn sie Dateien enthält, die den Grenzwert max_size nicht überschreiten. Wenn Sie nur Dateien ignorieren möchten, die eine bestimmte Größe überschreiten, und alle anderen verarbeiten möchten, verwenden Sie bitte 🤖/file/filter.

    Mit der Eigenschaft max_number_of_files können Sie die maximale Anzahl von Dateien für einen Upload festlegen, beispielsweise 100. Geben Sie diese an, um zu verhindern, dass Benutzer übermäßig viele Dateien hochladen – sowohl über Datei-Uploads als auch über Import-Robots.

    Diese Eigenschaften können entweder in der Assembly-Anfrage oder im Template festgelegt werden.

  • page

    number(Standard: 1)

    Gibt die aktuelle Seite innerhalb der derzeitigen Paginierung an.

  • pagesize

    number(Standard: 50)

    Gibt an, wie viele Templates pro API-Anfrage empfangen werden sollen. Dies ist für die Seitennummerierung nützlich.

  • sort

    id | name | created | modified(Standard: "created")

    Das Feld, nach dem sortiert werden soll.

  • order

    asc | desc(Standard: "desc")

    Die Sortierrichtung. Kann "desc" für absteigend (Standard) oder "asc" für aufsteigend sein.

  • fromdate — erforderlich

    string

    Gibt das früheste UTC-Erstellungsdatum mit Uhrzeit für Templates an. Es werden nur Templates abgerufen, die nach diesem Zeitpunkt erstellt wurden. Verwenden Sie das Format Y-m-d H:i:s.

  • todate

    string(Standard: "NOW()")

    Gibt das späteste UTC-Erstellungsdatum mit Uhrzeit für Templates an. Es werden nur Templates abgerufen, die vor diesem Zeitpunkt erstellt wurden. Verwenden Sie das Format Y-m-d H:i:s.

  • keywords

    Array<string>(Standard: [])

    Gibt Schlüsselwörter an, die mit den Namen von Templates abgeglichen werden. Wenn Builtin Templates einbezogen sind, werden auch deren Slugs durchsucht.

  • include_builtin

    none | latest | all | exclusively-latest | exclusively-all

    Nimmt Builtin Templates in die Ergebnisse auf. Verwenden Sie latest (empfohlen) oder all. Stellen Sie exclusively- voran, um ausschließlich Builtin Templates zurückzugeben.

Antwort

Gibt entweder den Fehlercode TEMPLATE_LIST_ERROR oder eine JSON-Liste der gefundenen Templates zurück. Verwenden Sie include_builtin, um von Transloadit verwaltete Builtin Templates in die Ergebnisse aufzunehmen.