Transloadit

Speicher-Assets auflisten

Listet Workspace-Assets mit stabilen Identitäten und Metadaten zur aktuellen Version auf Seiten mit begrenztem Umfang auf.

GEThttps://api2.transloadit.com/dam/assets

Gibt Metadaten zu den aktuellen Live-Assets im authentifizierten Workspace zurück, ohne deren Bytes herunterzuladen.

Übergeben Sie next_cursor mit demselben Präfix wieder als cursor, um die nächste Seite zu lesen. Beenden Sie den Vorgang, wenn next_cursor den Wert null hat. Die Seiten sind begrenzt und bilden keine Momentaufnahme: Gleichzeitige Verschiebungen, Schreibvorgänge oder Löschungen können spätere Seiten verändern.

Die zurückgegebenen Asset- und Versions-IDs können gespeichert und mit /transloadit/import verwendet werden. Verwenden Sie einen abschließenden Schrägstrich im Präfix, um eine Verzeichnisgrenze auszuwählen, etwa photos/ statt photos.

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 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 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=dam:read dam:write')"; 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 erneut, solange es gültig ist.

curl --fail-with-body -sS --request GET --get \
  --url "https://api2.transloadit.com/dam/assets" \
  --header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
  --data-urlencode 'params={"prefix":"photos/","limit":100}'

Authentifizierung

Dieser Endpunkt akzeptiert signierte params oder ein Bearer-Token. Anweisungen zur Einrichtung finden Sie unter Authentifizierung.

Erforderliche Berechtigungsumfänge für Auth Key oder Bearer-Token: dam:read, dam:write.

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

JSON in einem neuen Tab öffnen

params: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.

FeldTyp und Beschreibung
params.auth

für signierte Anfragen erforderlich; mit einem Bearer-Token optional

object

Enthält den Transloadit-API-Schlüssel und die Metadaten zur Signature Authentication für eine Anfrage nach Speichermetadaten.

params.auth: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.

params.auth.expires

erforderlich

string

ISO-8601-Ablaufzeitstempel in der Zukunft. Erforderlich, wenn eine Anfrage signiert ist oder Signaturauthentifizierung erfordert; mit Bearer authentifizierte Anfragen können ihn weglassen.

params.auth.key

erforderlich

string

Transloadit API-Schlüssel zur Authentifizierung von Anfragen

params.auth.nonce
string | integer

Eindeutiger Zufallswert, der in die Parameter signierter Anfragen aufgenommen wird, damit jede Signatur eindeutig ist und nicht versehentlich wiederverwendet werden kann.

params.cursor
string (minimale Länge: 1, maximale Länge: 512)

Opaker Fortsetzungswert aus next_cursor in der vorherigen Antwort. Behalten Sie beim seitenweisen Abrufen denselben Wert für prefix bei. Lassen Sie den Wert für die erste Seite weg.

params.limit
integer (Standardwert: 100, Minimum: 1, Maximum: 500)

Maximale Anzahl von Assets pro Seite. Der Standardwert ist 100, und es werden Werte bis zu 500 akzeptiert; folgen Sie next_cursor, bis der Wert null ist.

params.prefix
string (Standardwert: "", maximale Länge: 512)

Listen Sie nur aktuelle Asset-Pfade auf, die mit diesem Präfix beginnen (Groß- und Kleinschreibung wird beachtet). Der leere Standardwert umfasst den gesamten Workspace; fügen Sie einen abschließenden Schrägstrich hinzu, um eine Verzeichnisgrenze auszuwählen.

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

JSON in einem neuen Tab öffnen

params: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.

Verwendet die oben angegebenen Felddefinitionen: params.auth, params.cursor, params.limit, params.prefix

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

JSON in einem neuen Tab öffnen

params: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.

Verwendet die oben angegebenen Felddefinitionen: params.cursor, params.limit, params.prefix

FeldTyp und Beschreibung
params.auth
object

Enthält den Transloadit-API-Schlüssel und die Metadaten zur Signature Authentication für eine Anfrage nach Speichermetadaten.

params.auth: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.

params.auth.expires
string

ISO-8601-Ablaufzeitstempel in der Zukunft. Erforderlich, wenn eine Anfrage signiert ist oder Signaturauthentifizierung erfordert; mit Bearer authentifizierte Anfragen können ihn weglassen.

params.auth.key
string

Transloadit API-Schlüssel zur Authentifizierung von Anfragen

params.auth.nonce
string | integer

Eindeutiger Zufallswert, der in die Parameter signierter Anfragen aufgenommen wird, damit jede Signatur eindeutig ist und nicht versehentlich wiederverwendet werden kann.

Antwort

Hier sehen Sie ein Beispiel für einen Antworttext:

{
  "assets": [
    {
      "asset_id": "AAAAAAAAAAAAAAAAAAAAAA",
      "height": 600,
      "mime": "image/jpeg",
      "path": "renamed.jpg",
      "size": 12345,
      "version_id": "AAAAAAAAAAAAAAAAAAAAAQ",
      "width": 800,
      "workspace": "example-workspace"
    }
  ],
  "message": "The Storage assets were successfully listed.",
  "next_cursor": null,
  "ok": "DAM_ASSETS_LISTED",
  "workspace": "example-workspace"
}

2xx-Erfolg

JSON-Response-Body. application/json text/plain; charset=utf-8

Schema des Response-Bodys
Vollständiges JSON Schema

JSON in einem neuen Tab öffnen

Die Antwort enthält nur die für dieses Objekt aufgeführten Felder.

FeldTyp und Beschreibung
assets

erforderlich

Array<object>
Schema eines Array-Elements
object

assets[]: Die Antwort kann zusätzliche Felder enthalten.

FeldTyp und Beschreibung
assets[].asset_id

erforderlich

string

Stabile Asset-ID. Sie bleibt bei nativen Verschiebungen und Umbenennungen erhalten; verwenden Sie sie ohne Versionsangabe, um die aktuellen Bytes auszuwählen.

Validierungsmuster (regulärer Ausdruck)^[A-Za-z0-9_-]{21}[AQgw]$
assets[].height
integer (exklusives Minimum: 0, Maximum: 9007199254740991)

Anzeigehöhe in Pixeln nach Anwendung der EXIF-Ausrichtung, sofern bekannt.

assets[].md5hash
string

MD5-Prüfsumme der gespeicherten Bytes in Kleinbuchstaben, sofern verfügbar.

Validierungsmuster (regulärer Ausdruck)^[a-f0-9]{32}$
assets[].mime

erforderlich

null | string

MIME-Typ der gespeicherten Bytes oder null, wenn der Typ unbekannt ist.

assets[].path

erforderlich

string (minimale Länge: 1)

Aktueller veränderlicher Speicherort relativ zum Workspace. Nach einer Umbenennung ist der vorherige Pfad veraltet; durch Überschreiben können sich die Bytes unter diesem Pfad ändern.

assets[].sha256
string

SHA-256-Prüfsumme der gespeicherten Bytes in Kleinbuchstaben, sofern verfügbar.

Validierungsmuster (regulärer Ausdruck)^[a-f0-9]{64}$
assets[].size

erforderlich

integer (Minimum: 0, Maximum: 9007199254740991)

Größe der gespeicherten Datei in Bytes.

assets[].version_id

erforderlich

string

Exakte, unveränderliche Version dieses Assets. Verwenden Sie sie zusammen mit asset_id, um die aufbewahrten Bytes auszuwählen; bei einer fehlenden Version wird niemals auf die aktuelle Version zurückgegriffen.

Validierungsmuster (regulärer Ausdruck)^[A-Za-z0-9_-]{21}[AQgw]$
assets[].width
integer (exklusives Minimum: 0, Maximum: 9007199254740991)

Anzeigebreite in Pixeln nach Anwendung der EXIF-Ausrichtung, sofern bekannt.

assets[].workspace

erforderlich

string (minimale Länge: 1)

Slug des Workspaces, dem dieses Asset gehört. Authentifizieren Sie sich für denselben Workspace, wenn Sie das Asset lesen oder verwalten.

message

erforderlich

string (minimale Länge: 1)
next_cursor

erforderlich

null | string
ok

erforderlich

string (immer: "DAM_ASSETS_LISTED")
workspace

erforderlich

string (minimale Länge: 1)

Slug des Workspaces, dem dieses Asset gehört. Authentifizieren Sie sich für denselben Workspace, wenn Sie das Asset lesen oder verwalten.

Fehlerantwort

JSON-Response-Body. application/json text/plain; charset=utf-8

Schema des Response-Bodys
Vollständiges JSON Schema

JSON in einem neuen Tab öffnen

Mindestens eine dieser Eigenschaften ist erforderlich: error, message, reason

Die Antwort kann zusätzliche Felder enthalten.

FeldTyp und Beschreibung
assembly_id
string
error
string (minimale Länge: 1)
http_code
number | string
  • number
  • string
    Validierungsmuster (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]*[+-]?0*(?:0(?:[^0-9]|$)|(?:[1-9][0-9]{0,307}|1(?:(?:[0-6][0-9]{7}|7[0-8][0-9]{6}|79[0-6][0-9]{5}|797[0-5][0-9]{4}|7976[0-8][0-9]{3}|79769[0-2][0-9]{2}|7976930[0-9]{1}|7976931[0-2])[0-9]{300}|79769313(?:(?:[0-3][0-9]{7}|4[0-7][0-9]{6}|48[0-5][0-9]{5}|486[0-1][0-9]{4}|4862[0-2][0-9]{3}|486230[0-9]{2}|486231[0-4][0-9]{1}|4862315[0-7])[0-9]{292}|48623158(?:(?:0[0-6][0-9]{6}|07[0-8][0-9]{5}|079[0-2][0-9]{4}|0793[0-6][0-9]{3}|07937[0-1][0-9]{2}|079372[0-7][0-9]{1}|0793728[0-8])[0-9]{284}|07937289(?:(?:[0-6][0-9]{7}|70[0-9]{6}|71[0-3][0-9]{5}|7140[0-4][0-9]{3}|71405[0-2][0-9]{2}|7140530[0-2])[0-9]{276}|71405303(?:(?:[0-3][0-9]{7}|40[0-9]{6}|41[0-4][0-9]{5}|4150[0-6][0-9]{3}|41507[0-8][0-9]{2}|415079[0-8][0-9]{1}|4150799[0-2])[0-9]{268}|41507993(?:(?:[0-3][0-9]{7}|40[0-9]{6}|41[0-2][0-9]{5}|413[0-1][0-9]{4}|4132[0-6][0-9]{3}|413270[0-9]{2})[0-9]{260}|41327100(?:(?:[0-2][0-9]{7}|3[0-6][0-9]{6}|37[0-7][0-9]{5}|378[0-1][0-9]{4}|3782[0-5][0-9]{3}|37826[0-8][0-9]{2}|378269[0-2][0-9]{1}|3782693[0-5])[0-9]{252}|37826936(?:(?:0[0-9]{7}|1[0-6][0-9]{6}|17[0-2][0-9]{5}|173[0-6][0-9]{4}|1737[0-6][0-9]{3}|17377[0-7][0-9]{2}|173778[0-8][0-9]{1}|1737789[0-7])[0-9]{244}|17377898(?:(?:0[0-3][0-9]{6}|04[0-3][0-9]{5}|044[0-3][0-9]{4}|0444[0-8][0-9]{3}|04449[0-5][0-9]{2}|044496[0-7][0-9]{1}|0444968[0-1])[0-9]{236}|04449682(?:(?:[0-8][0-9]{7}|9[0-1][0-9]{6}|92[0-6][0-9]{5}|927[0-5][0-9]{4}|9276[0-3][0-9]{3}|92764[0-6][0-9]{2}|927647[0-4][0-9]{1})[0-9]{228}|92764750(?:(?:[0-8][0-9]{7}|9[0-3][0-9]{6}|94[0-5][0-9]{5}|946[0-5][0-9]{4}|9466[0-3][0-9]{3}|94664[0-8][0-9]{2}|94664900)[0-9]{220}|94664901(?:(?:[0-6][0-9]{7}|7[0-8][0-9]{6}|79[0-6][0-9]{5}|797[0-6][0-9]{4}|7977[0-4][0-9]{3}|79775[0-7][0-9]{2}|797758[0-6][0-9]{1}|7977587[0-1])[0-9]{212}|79775872(?:(?:0[0-6][0-9]{6}|070[0-8][0-9]{4}|0709[0-5][0-9]{3}|07096[0-2][0-9]{2}|070963[0-2][0-9]{1})[0-9]{204}|07096330(?:(?:[0-1][0-9]{7}|2[0-7][0-9]{6}|28[0-5][0-9]{5}|286[0-3][0-9]{4}|28640[0-9]{3}|28641[0-5][0-9]{2}|286416[0-5][0-9]{1}|2864166[0-8])[0-9]{196}|28641669(?:(?:[0-1][0-9]{7}|2[0-7][0-9]{6}|28[0-7][0-9]{5}|288[0-6][0-9]{4}|2887[0-8][0-9]{3}|288790[0-9]{2}|2887910[0-8])[0-9]{188}|28879109(?:(?:[0-3][0-9]{7}|4[0-5][0-9]{6}|46[0-4][0-9]{5}|465[0-4][0-9]{4}|4655[0-4][0-9]{3}|46555[0-4][0-9]{2}|465555[0-3][0-9]{1}|4655554[0-6])[0-9]{180}|46555547(?:(?:[0-7][0-9]{7}|8[0-4][0-9]{6}|850[0-9]{5}|851[0-8][0-9]{4}|8519[0-3][0-9]{3}|851940[0-3][0-9]{1})[0-9]{172}|85194040(?:(?:[0-1][0-9]{7}|2[0-5][0-9]{6}|26[0-2][0-9]{5}|2630[0-5][0-9]{3}|26306[0-4][0-9]{2}|263065[0-6][0-9]{1}|2630657[0-3])[0-9]{164}|26306574(?:(?:[0-7][0-9]{7}|8[0-7][0-9]{6}|88[0-5][0-9]{5}|886[0-6][0-9]{4}|88670[0-9]{3}|88671[0-4][0-9]{2}|8867150[0-4])[0-9]{156}|88671505(?:(?:[0-7][0-9]{7}|8[0-1][0-9]{6}|820[0-5][0-9]{4}|8206[0-7][0-9]{3}|820680[0-9]{2}|820681[0-8][0-9]{1})[0-9]{148}|82068190(?:(?:[0-7][0-9]{7}|8[0-8][0-9]{6}|890[0-1][0-9]{4}|8902000[0-6])[0-9]{140}|89020007(?:(?:0[0-7][0-9]{6}|08[0-2][0-9]{5}|083[0-7][0-9]{4}|0838[0-2][0-9]{3}|08383[0-5][0-9]{2}|083836[0-6][0-9]{1}|0838367[0-5])[0-9]{132}|08383676(?:(?:[0-1][0-9]{7}|2[0-6][0-9]{6}|27[0-2][0-9]{5}|273[0-7][0-9]{4}|2738[0-4][0-9]{3}|27385[0-3][0-9]{2}|273854[0-7][0-9]{1}|2738548[0-3])[0-9]{124}|27385484(?:(?:[0-4][0-9]{7}|5[0-7][0-9]{6}|580[0-9]{5}|581[0-6][0-9]{4}|5817[0-6][0-9]{3}|581770[0-9]{2}|5817710[0-9]{1}|5817711[0-4])[0-9]{116}|58177115(?:(?:[0-2][0-9]{7}|30[0-9]{6}|31[0-6][0-9]{5}|317[0-5][0-9]{4}|3176[0-3][0-9]{3}|31764[0-3][0-9]{2}|317644[0-6][0-9]{1}|3176447[0-4])[0-9]{108}|31764475(?:(?:[0-6][0-9]{7}|7[0-2][0-9]{6}|730[0-1][0-9]{4}|7302[0-6][0-9]{3}|7302700[0-5])[0-9]{100}|73027006(?:(?:[0-8][0-9]{7}|9[0-7][0-9]{6}|98[0-4][0-9]{5}|985[0-4][0-9]{4}|9855[0-4][0-9]{3}|98555[0-6][0-9]{2}|9855570[0-9]{1}|9855571[0-2])[0-9]{92}|98555713(?:(?:[0-5][0-9]{7}|6[0-5][0-9]{6}|66[0-8][0-9]{5}|669[0-4][0-9]{4}|6695[0-8][0-9]{3}|66959[0-5][0-9]{2}|669596[0-1][0-9]{1}|6695962[0-1])[0-9]{84}|66959622(?:(?:[0-7][0-9]{7}|8[0-3][0-9]{6}|84[0-1][0-9]{5}|842[0-8][0-9]{4}|84290[0-9]{3}|84291[0-3][0-9]{2}|842914[0-7][0-9]{1}|84291480)[0-9]{76}|84291481(?:(?:[0-8][0-9]{7}|9[0-7][0-9]{6}|98[0-5][0-9]{5}|9860[0-7][0-9]{3}|98608[0-2][0-9]{2}|986083[0-3][0-9]{1}|9860834[0-8])[0-9]{68}|98608349(?:(?:[0-2][0-9]{7}|3[0-5][0-9]{6}|36[0-3][0-9]{5}|364[0-6][0-9]{4}|3647[0-4][0-9]{3}|36475[0-1][0-9]{2}|364752[0-8][0-9]{1}|3647529[0-1])[0-9]{60}|36475292(?:(?:[0-6][0-9]{7}|70[0-9]{6}|71[0-8][0-9]{5}|7190[0-6][0-9]{3}|71907[0-3][0-9]{2}|7190740[0-9]{1}|7190741[0-5])[0-9]{52}|71907416(?:(?:[0-7][0-9]{7}|8[0-3][0-9]{6}|84[0-3][0-9]{5}|844[0-3][0-9]{4}|8444[0-2][0-9]{3}|84443[0-5][0-9]{2}|844436[0-4][0-9]{1}|8444365[0-4])[0-9]{44}|84443655(?:(?:0[0-9]{7}|10[0-6][0-9]{5}|1070[0-3][0-9]{3}|10704[0-2][0-9]{2}|107043[0-3][0-9]{1}|1070434[0-1])[0-9]{36}|10704342(?:(?:[0-6][0-9]{7}|70[0-9]{6}|710[0-9]{5}|711[0-4][0-9]{4}|7115[0-4][0-9]{3}|71155[0-8][0-9]{2}|711559[0-5][0-9]{1}|7115596[0-8])[0-9]{28}|71155969(?:(?:[0-8][0-9]{7}|9[0-4][0-9]{6}|950[0-7][0-9]{4}|95080[0-8][0-9]{2}|950809[0-2][0-9]{1})[0-9]{20}|95080930(?:(?:[0-3][0-9]{7}|4[0-1][0-9]{6}|42[0-7][0-9]{5}|428[0-7][0-9]{4}|428800[0-9]{2}|428801[0-6][0-9]{1}|4288017[0-6])[0-9]{12}|42880177(?:(?:[0-8][0-9]{7}|90[0-3][0-9]{5}|9040[0-9]{4}|9041[0-6][0-9]{3}|90417[0-3][0-9]{2}|904174[0-3][0-9]{1}|9041744[0-8])[0-9]{4}|90417449(?:(?:[0-6][0-9]{3}|7[0-6][0-9]{2}|77[0-8][0-9]{1}|7790)|7791))))))))))))))))))))))))))))))))))))))))(?:[^0-9]|$))
message
string

Menschenlesbare Erklärung des Fehlers. Die Formulierung kann variieren; verwenden Sie den Code error, wenn Sie einen bestimmten Fehlerfall behandeln.

reason
null | string | number | boolean | Array<beliebiger Wert> | object

Eines der folgenden Schemas kann gelten:

null
null
string
string
number
number
boolean
boolean
Array<beliebiger Wert>
Array<beliebiger Wert>
Schema eines Array-Elements
beliebiger Wert
object
object
Schema für zusätzliche Eigenschaften
beliebiger Wert