Liste der Assemblies abrufen
Listet alle Assemblies für den authentifizierten Workspace auf.
https://api2.transloadit.com/Ruft eine Liste der Assemblies für Ihr Konto ab. Sie sind nach Erstellungsdatum absteigend sortiert.
Anfragebeispiel
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 den folgenden Abschnitt zur Einrichtung 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 Ihren Auth Key bzw. Ihr Auth Secret. Halten Sie beide Zugangsdaten und das daraus 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=assemblies: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 unten stehende Anfrage aus. Verwenden Sie das Token wieder, solange es gültig ist.
curl --fail-with-body -sS --request GET --get \
--url "https://api2.transloadit.com/assemblies" \
--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: assemblies: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. | stringBeschränkt die Ergebnisse auf eine einzelne Assembly-ID. Validierungsmuster (regulärer Ausdruck)^[a-z0-9]{32}$ |
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 Anfrage zum Auflisten von Assemblies.
|
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 Assemblies an. Nur Assemblies nach diesem Zeitpunkt werden zurückgegeben. Verwenden Sie das Format |
params. | string | Array<string>Gibt einen einzelnen Suchausdruck direkt oder als String-Array an, dessen Elemente durch Kommas verbunden werden. Gerenderte Ausdrücke, die nach dem Trimmen nicht leer sind, müssen nach dem Trimmen mindestens drei Zeichen enthalten. Der Ausdruck findet Übereinstimmungen mit einer Assembly ID oder einem sechs Zeichen langen ID-Präfix, einem erkannten Fehlercode oder (wenn die Suche in Assembly-Feldern für den Workspace aktiviert ist) einem exakten benutzerdefinierten Feldnamen oder -wert. Wenn ein erkannter Fehlercode auch mit einem benutzerdefinierten Feldnamen oder -wert übereinstimmt, werden nur Assemblies zurückgegeben, die mit beiden übereinstimmen. Standardmäßig wird kein Schlüsselwortfilter angewendet. Eines der folgenden Schemas kann gelten: stringstringValidierungsmuster (regulärer Ausdruck)^(?:[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*|[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*[^\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff](?:[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]|[^\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff])+[^\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff][\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*)$Array<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"Gibt die Sortierrichtung an. Der Standardwert ist |
params. | integer (Standardwert: 1, Minimum: 1, Maximum: 9007199254740991)Gibt die aktuelle Seite innerhalb der derzeitigen Paginierung an. Standardwert ist |
params. | integer (Standardwert: 50, Minimum: 1, Maximum: 5000)Gibt an, wie viele Assemblies pro API-Anfrage zurückgegeben werden. Der Standardwert ist |
params. | stringBeschränkt die Ergebnisse auf eine Region. Wird der Wert weggelassen, enthält er nur Leerzeichen oder lautet er Eines der folgenden Schemas kann gelten: Variante 1: stringstringValidierungsmuster (regulärer Ausdruck)^[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*$Variante 2: stringstringValidierungsmuster (regulärer Ausdruck)^[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*[A-Za-z0-9._-]{1,30}[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*$ |
params. | "created" | "created_ts" | "updated"Gibt das Feld an, nach dem die Ergebnisse sortiert werden. Standardwert ist |
params. | stringBeschränkt die Ergebnisse auf eine Template-ID oder einen Template-Namen. Verwenden Sie |
params. | stringGibt das späteste UTC-Erstellungsdatum mit Uhrzeit für Assemblies an. Nur Assemblies vor diesem Zeitpunkt werden zurückgegeben. Verwenden Sie das Format |
params. | stringGibt die Typen der abzurufenden Assemblies an. Der Standardwert ist Zulässige Werte (10)
|
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.assembly_id, params.auth, params.fromdate, params.keywords, params.nonce, params.order, params.page, params.pagesize, params.region, params.sort, params.template_id, params.todate, params.type
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.assembly_id, params.fromdate, params.keywords, params.nonce, params.order, params.page, params.pagesize, params.region, params.sort, params.template_id, params.todate, params.type
| Feld | Typ und Beschreibung |
|---|---|
params. | Enthält den Transloadit-API-Schlüssel und Metadaten für die Signature Authentication einer Anfrage zum Auflisten von Assemblies.
|
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
Hier sehen Sie ein Beispiel für einen Antworttext:
{
"count": 50,
"items": [
{
"account_id": "7c91e50845204dea9ed4791f7d8440f1",
"created": "2023-02-11T16:04:22.000Z",
"created_ts": 1676131462,
"error": null,
"execution_duration": 2.337,
"execution_start": "2023-02-11T16:04:24.000Z",
"files": "[\"Saturn as seen from the Cas....jpg\"]",
"id": "195c60855fda4fb9a3b2f848374ca4e1",
"instance": "tam.transloadit.com",
"notify_url": null,
"ok": "ASSEMBLY_COMPLETED",
"parent_id": null,
"redirect_url": null,
"region": "eu-west-1",
"template_id": "40b0efc6b37f432dbe9485017b52a7b7",
"template_name": "my-template-1676131432311",
"warning_count": 0
},
{
"account_id": "7c91e50845204dea9ed4791f7d8440f1",
"created": "2023-02-11T16:04:04.000Z",
"created_ts": 1676131444,
"error": null,
"execution_duration": 6.275,
"execution_start": "2023-02-11T16:04:06.000Z",
"files": "[\"green grass fiels.jpg\",\"Morning Dew.jpg\",\"green leaf plant.jpg\"]",
"id": "72fc13f46db84fa1969d913ca8763de1",
"instance": "tam.transloadit.com",
"notify_url": null,
"ok": "ASSEMBLY_COMPLETED",
"parent_id": null,
"redirect_url": null,
"region": "eu-west-1",
"template_id": "40b0efc6b37f432dbe9485017b52a7b7",
"template_name": "my-template-1676131432311",
"warning_count": 0
}
]
}2xx-Erfolg
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 | ||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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: "ASSEMBLY_LIST_ERROR"
Ungültige Parameter.
Die Antwort kann zusätzliche Felder enthalten.