Liste der Templates abrufen
Listet die für den authentifizierten Workspace verfügbaren Templates auf.
https://api2.transloadit.com/ templatesAnfragebeispiel
Gekündigte Workspaces können keine neuen Bearer-Tokens erstellen. Dieser Endpunkt bleibt mit einem vorhandenen aktiven Auth Key verfügbar: Verwenden Sie die Anleitung für signierte Lesezugriffe anstelle der unten beschriebenen Token-Einrichtung. Der Auth Key muss die für diesen Endpunkt erforderlichen Scopes gewähren.
Führen Sie diese Anfrage in einer serverseitigen Shell mit curl und einem geeigneten Bearer-Token in TRANSLOADIT_TOKEN aus. Wenn Sie ein Token benötigen, klappen Sie die folgende Einrichtungsanleitung auf.
Benötigen Sie ein Bearer-Token?
Setzen Sie in einer vertrauenswürdigen serverseitigen Shell mit curl und jq die Variablen TRANSLOADIT_KEY und TRANSLOADIT_SECRET auf die Werte Ihres Auth Keys bzw. Ihres Auth Secrets. Halten Sie beide Zugangsdaten und das resultierende Token geheim; führen Sie diese Einrichtung niemals in Browsercode aus.
Erstellen Sie zunächst ein Token mit den für diesen Endpunkt erforderlichen Scopes. Ihr Auth Key muss diese Scopes bereits gewähren.
if ! TOKEN_RESPONSE="$(curl --fail-with-body -sS \
--request POST \
--url 'https://api2.transloadit.com/token' \
--user "${TRANSLOADIT_KEY:?Set TRANSLOADIT_KEY}:${TRANSLOADIT_SECRET:?Set TRANSLOADIT_SECRET}" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'aud=api2' \
--data-urlencode 'scope=templates:read')"; then
printf '%s\n' "$TOKEN_RESPONSE" >&2
exit 1
fi
TRANSLOADIT_TOKEN="$(printf '%s' "$TOKEN_RESPONSE" |
jq -er '.access_token | strings | select(length > 0)')" || exit 1
Lassen Sie diese Shell geöffnet und führen Sie die folgende Anfrage aus. Verwenden Sie das Token wieder, solange es gültig bleibt.
curl --fail-with-body -sS --request GET --get \
--url "https://api2.transloadit.com/templates" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--data-urlencode 'params={}'
Authentifizierung
Dieser Endpunkt akzeptiert signierte params oder ein Bearer-Token. Anweisungen zur Einrichtung finden Sie unter Authentifizierung.
Erforderlicher Berechtigungsumfang für Auth Key oder Bearer-Token: templates:read.
Signierte Anfragen erfordern sowohl eine signature als auch einen in der Zukunft liegenden Zeitstempel für params.auth.expires. Bearer-Tokens erfordern keines von beiden.
Query-Parameter
params(JSON-Zeichenfolge). Ein JSON-codiertes Objekt, dessen unterstützte Schlüssel unten aufgeführt sind.signature(Zeichenfolge). Für signierte Anfragen erforderlich. Lassen Sie dieses Feld weg, wenn Sie ein Bearer-Token verwenden.
Unterstützte Schlüssel im signierten Feld params
Die Authentifizierungsfelder in dieser Liste gelten für signierte Anfragen. Mit einem Bearer-Token können Sie params.auth und das separate Feld signature weglassen. Vergleichen Sie unten die Anfrageparameter der einzelnen Authentifizierungsmethoden.
Vollständiges JSON Schema
params: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.
| Feld | Typ und Beschreibung |
|---|---|
params.für signierte Anfragen erforderlich; mit einem Bearer-Token optional | Enthält den Transloadit-API-Schlüssel und Metadaten für die Signature Authentication einer Template-Anfrage.
|
params.erforderlich | stringISO-8601-Ablaufzeitstempel in der Zukunft. Erforderlich, wenn eine Anfrage signiert ist oder Signaturauthentifizierung erfordert; mit Bearer authentifizierte Anfragen können ihn weglassen. |
params.erforderlich | stringTransloadit API-Schlüssel zur Authentifizierung von Anfragen |
params. | stringGibt das früheste UTC-Erstellungsdatum mit Uhrzeit für Workspace Templates an. Es werden nur Workspace Templates zurückgegeben, die zu oder nach diesem Zeitpunkt erstellt wurden; Builtin Templates werden nicht nach Erstellungsdatum gefiltert. Verwenden Sie einen UTC-Zeitstempel wie |
params. | "all" | "exclusively-all" | "exclusively-latest" | "latest" | "none" (Standardwert: "none")Steuert, ob Builtin Templates einbezogen werden. Verwenden Sie |
params. | string | Array<string> (Standardwert: "")Filtert die Namen von Templates im Workspace anhand eines SQL-LIKE-Musters, das von Eines der folgenden Schemas kann gelten: stringArray<string>Array<string>Schema eines Array-Elementsstring |
params. | string | integerEindeutiger Zufallswert, der in die Parameter signierter Anfragen aufgenommen wird, damit jede Signatur eindeutig ist und nicht versehentlich wiederverwendet werden kann. |
params. | "asc" | "desc" (Standardwert: "desc")Gibt die Sortierrichtung für Workspace Templates an. Ändert nicht die Reihenfolge von Builtin Templates. Der Standardwert ist |
params. | integer (Standardwert: 1, Minimum: 1, Maximum: 9007199254740991)Gibt die aktuelle Seite innerhalb der derzeitigen Paginierung an. Der Standardwert ist |
params. | integer (Standardwert: 850, Minimum: 1, Maximum: 850)Gibt an, wie viele Templates pro API-Anfrage zurückgegeben werden. Der Standardwert ist |
params. | "created" | "id" | "last_used" | "modified" | "name" (Standardwert: "created")Gibt das Feld an, nach dem Workspace Templates sortiert werden. Ändert nicht die Reihenfolge von Builtin Templates. Der Standardwert ist |
params. | stringGibt das späteste UTC-Erstellungsdatum mit Uhrzeit für Workspace Templates an. Es werden nur Workspace Templates zurückgegeben, die zu oder vor diesem Zeitpunkt erstellt wurden; Builtin Templates werden nicht nach Erstellungsdatum gefiltert. Verwenden Sie einen UTC-Zeitstempel wie |
Anfrageparameter nach Authentifizierungsmethode
Mit signierten Parametern
Geben Sie Ihren Auth Key als params.auth.key an. Wenn Sie die Anfrage signieren, geben Sie einen in der Zukunft liegenden Zeitstempel für params.auth.expires an und senden Sie die Signature im separaten Feld signature. Die folgenden Felddefinitionen verwenden Pfade innerhalb von params.
Vollständiges JSON Schema
params: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.
Verwendet die oben angegebenen Felddefinitionen: params.auth, params.fromdate, params.include_builtin, params.keywords, params.nonce, params.order, params.page, params.pagesize, params.sort, params.todate
Mit einem Bearer-Token
Senden Sie das Bearer-Token im Authorization-Header. Sie können params.auth und das separate Feld signature weglassen. Die übrigen erforderlichen Parameter müssen weiterhin angegeben werden. Die folgenden Felddefinitionen verwenden Pfade innerhalb von params.
Vollständiges JSON Schema
params: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.
Verwendet die oben angegebenen Felddefinitionen: params.fromdate, params.include_builtin, params.keywords, params.nonce, params.order, params.page, params.pagesize, params.sort, params.todate
| Feld | Typ und Beschreibung |
|---|---|
params. | Enthält den Transloadit-API-Schlüssel und Metadaten für die Signature Authentication einer Template-Anfrage.
|
params. | stringISO-8601-Ablaufzeitstempel in der Zukunft. Erforderlich, wenn eine Anfrage signiert ist oder Signaturauthentifizierung erfordert; mit Bearer authentifizierte Anfragen können ihn weglassen. |
params. | stringTransloadit API-Schlüssel zur Authentifizierung von Anfragen |
Antwort
2xx-Erfolg
JSON-Response-Body. application/json text/plain; charset=utf-8
Schema des Response-Bodys
Vollständiges JSON Schema
Die Antwort enthält nur die für dieses Objekt aufgeführten Felder.
| Feld | Typ und Beschreibung | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
counterforderlich | integer (Minimum: 0) | ||||||||||||||||||||||||||||||||
itemserforderlich | Array<object>Schema eines Array-Elements
|
Fehlerantwort
JSON-Response-Body. application/json text/plain; charset=utf-8
Schema des Response-Bodys
Vollständiges JSON Schema
Die Antwort kann zusätzliche Felder enthalten.
| Feld | Typ und Beschreibung |
|---|---|
assembly_id | string |
error | string (minimale Länge: 1) |
http_code | number | string
|
message | stringMenschenlesbare Erklärung des Fehlers. Die Formulierung kann variieren; verwenden Sie den Code |
reason | null | string | number | boolean | Array<beliebiger Wert> | objectEines der folgenden Schemas kann gelten: nullstringnumberbooleanArray<beliebiger Wert>Array<beliebiger Wert>Schema eines Array-Elementsbeliebiger WertobjectobjectSchema für zusätzliche Eigenschaftenbeliebiger Wert |
HTTP 400
JSON-Response-Body. application/json text/plain; charset=utf-8
Schema des Response-Bodys
Vollständiges JSON Schema
Benannte Fehler und das allgemeine Fehlerformat
error: "TEMPLATE_LIST_ERROR"
Ungültige Parameter.
Die Antwort kann zusätzliche Felder enthalten.