Transloadit

Obtener un activo de almacenamiento

Devuelve la versión actual o conservada explícitamente de un activo de un Workspace mediante su identidad estable.

GEThttps://api2.transloadit.com/dam/assets/{assetId}

Antes de llamar a este endpoint, obtén los IDs de los activos existentes en el mismo Workspace que la Auth Key utilizada para la solicitud.

Para los archivos almacenados con /transloadit/store, consulta su Assembly Status y espera a que sea ASSEMBLY_COMPLETED. En los arrays results[stepName] devueltos, conserva los valores de workspace, asset_id, version_id y el path devuelto de cada archivo almacenado. El id ordinario del archivo no es su ID de activo de Storage. Usa asset_id para ASSET_ID o params.asset_ids en los ejemplos siguientes.

Usa asset_id para seguir un activo a través de movimientos y cambios de nombre nativos. Añade version_id al importar para seleccionar los mismos bytes conservados tras una sobrescritura. Una ruta guardada es una ubicación mutable, no una referencia inmutable. Las condiciones de acceso y conservación de versiones siguen siendo aplicables.

Omite version_id para recuperar la versión actual. Inclúyelo para recuperar una versión exacta conservada de este activo. Una versión inexistente, eliminada o perteneciente a otro propietario devuelve un error; nunca se recurre a los bytes actuales como alternativa.

El asset devuelto tiene la misma estructura de referencia que un resultado almacenado de una Assembly. Su ruta refleja la ubicación actual del activo incluso cuando se selecciona una versión anterior.

Ejemplo de solicitud

Asigna a ASSET_ID el valor de tu recurso sin codificarlo mediante porcentajes.

Ejecuta esta solicitud en una shell del servidor con curl y un token Bearer adecuado en TRANSLOADIT_TOKEN. Si necesitas un token, despliega la sección de configuración siguiente.

¿Necesitas un token Bearer?

En una shell de confianza del servidor con curl y jq, asigna a TRANSLOADIT_KEY y TRANSLOADIT_SECRET tu Auth Key y tu Auth Secret, respectivamente. Mantén en secreto ambas credenciales y el token resultante; nunca ejecutes esta configuración en código del navegador.

Primero, crea un token con los ámbitos requeridos por este endpoint. Tu Auth Key ya debe conceder esos ámbitos.

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

Mantén abierta esta shell y ejecuta la solicitud siguiente. Reutiliza el token mientras siga siendo válido.

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

Autenticación

Este endpoint acepta params firmados o un token Bearer. Consulta Autenticación para ver las instrucciones de configuración.

Ámbitos requeridos para el Auth Key o el token de portador: dam:read, dam:write.

Las solicitudes firmadas requieren tanto una signature como una marca de tiempo futura en params.auth.expires. Los tokens Bearer no requieren ninguno de estos dos elementos.

Parámetros de ruta

  • assetId (segmento de ruta), obligatorio. patrón: ^[A-Za-z0-9_-]{21}[AQgw]$, longitud mínima: 22, longitud máxima: 22

Parámetros de consulta

  • params (cadena JSON). Un objeto codificado en JSON cuyas claves compatibles se enumeran a continuación.

  • signature (cadena). Obligatorio para las solicitudes firmadas. Omite este campo cuando uses un token Bearer.

Claves admitidas en el campo firmado params

Los campos de autenticación de esta lista se aplican a las solicitudes firmadas. Con un token Bearer puedes omitir params.auth y el campo separado signature. Compara a continuación los parámetros de solicitud de cada método de autenticación.

JSON Schema completo

Abrir JSON en una pestaña nueva

params: Solo se aceptan los campos enumerados para este objeto.

CampoTipo y descripción
params.auth

obligatorio para las solicitudes firmadas; opcional con un token Bearer

object

Contiene la clave de API de Transloadit y los metadatos de Signature Authentication para una solicitud de metadatos de almacenamiento.

params.auth: Solo se aceptan los campos enumerados para este objeto.

params.auth.expires

obligatorio

string

Marca de tiempo de vencimiento ISO 8601 en el futuro. Es obligatoria cuando una solicitud está firmada o requiere autenticación mediante firma; las solicitudes autenticadas con Bearer pueden omitirla.

params.auth.key

obligatorio

string

Clave de API de Transloadit utilizada para autenticar solicitudes

params.nonce
string | integer

Valor aleatorio y único incluido en los parámetros de las solicitudes firmadas para que cada firma sea única y evitar su reutilización accidental.

params.version_id
string

Versión retenida opcional del activo seleccionado. Omite este valor para usar la versión actual. Si la versión no existe o se ha eliminado, se devuelve un error y nunca se recurre a los bytes de la versión actual.

Patrón de validación (expresión regular)^[A-Za-z0-9_-]{21}[AQgw]$

Parámetros de solicitud según el método de autenticación

Con parámetros firmados

Incluye tu Auth Key como params.auth.key. Al firmar la solicitud, incluye una marca de tiempo futura en params.auth.expires y envía la Signature en el campo separado signature. Las definiciones de los campos que aparecen a continuación usan rutas dentro de params.

JSON Schema completo

Abrir JSON en una pestaña nueva

params: Solo se aceptan los campos enumerados para este objeto.

Utiliza las definiciones de campos indicadas arriba: params.auth, params.nonce, params.version_id

Con un token Bearer

Envía el token Bearer en el encabezado Authorization. Puedes omitir params.auth y el campo independiente signature. Los demás parámetros obligatorios siguen siendo necesarios. Las definiciones de los campos que aparecen a continuación usan rutas dentro de params.

JSON Schema completo

Abrir JSON en una pestaña nueva

params: Solo se aceptan los campos enumerados para este objeto.

Utiliza las definiciones de campos indicadas arriba: params.nonce, params.version_id

CampoTipo y descripción
params.auth
object

Contiene la clave de API de Transloadit y los metadatos de Signature Authentication para una solicitud de metadatos de almacenamiento.

params.auth: Solo se aceptan los campos enumerados para este objeto.

params.auth.expires
string

Marca de tiempo de vencimiento ISO 8601 en el futuro. Es obligatoria cuando una solicitud está firmada o requiere autenticación mediante firma; las solicitudes autenticadas con Bearer pueden omitirla.

params.auth.key
string

Clave de API de Transloadit utilizada para autenticar solicitudes

Respuesta

Este es un ejemplo del cuerpo de la respuesta:

{
  "asset": {
    "asset_id": "AAAAAAAAAAAAAAAAAAAAAA",
    "height": 600,
    "mime": "image/jpeg",
    "path": "renamed.jpg",
    "size": 12345,
    "version_id": "AAAAAAAAAAAAAAAAAAAAAQ",
    "width": 800,
    "workspace": "example-workspace"
  },
  "message": "The Storage asset was successfully found.",
  "ok": "DAM_ASSET_FOUND"
}

éxito 2xx

Cuerpo de respuesta JSON. application/json text/plain; charset=utf-8

Esquema del cuerpo de la respuesta
JSON Schema completo

Abrir JSON en una pestaña nueva

La respuesta contiene únicamente los campos listados para este objeto.

CampoTipo y descripción
asset

obligatorio

object

asset: La respuesta puede contener campos adicionales.

asset.asset_id

obligatorio

string

ID estable del activo. Se conserva tras los movimientos y cambios de nombre nativos; úsalo sin una versión para seleccionar los bytes actuales.

Patrón de validación (expresión regular)^[A-Za-z0-9_-]{21}[AQgw]$
asset.has_alpha
boolean

Indica si la imagen tiene un canal alfa, aunque todos sus píxeles sean opacos. Está presente cuando la extracción de ThumbHash se realiza correctamente; su ausencia significa que se desconoce.

asset.height
integer (mínimo exclusivo: 0, máximo: 9007199254740991)

Altura de visualización en píxeles, después de aplicar la orientación EXIF, cuando se conoce.

asset.md5hash
string

Suma de comprobación MD5 en minúsculas de los bytes almacenados, cuando esté disponible.

Patrón de validación (expresión regular)^[a-f0-9]{32}$
asset.mime

obligatorio

null | string

Tipo MIME de los bytes almacenados, o null si se desconoce.

asset.path

obligatorio

string (longitud mínima: 1)

Ubicación actual mutable relativa al Workspace. Un cambio de nombre deja obsoleta la ruta anterior; una sobrescritura puede cambiar los bytes en esta ruta.

asset.sha256
string

Suma de comprobación SHA-256 en minúsculas de los bytes almacenados, cuando esté disponible.

Patrón de validación (expresión regular)^[a-f0-9]{64}$
asset.size

obligatorio

integer (mínimo: 0, máximo: 9007199254740991)

Tamaño del archivo almacenado en bytes.

asset.thumbhash
string

ThumbHash codificado en Base64 de los píxeles mostrados de esta versión, cuando se solicita con output_meta.thumbhash en el Step que la produce. Son datos de imagen: aplica los mismos controles de acceso que al original.

Patrón de validación (expresión regular)^(?:[A-Za-z0-9+/]{4}){1,15}(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)$
asset.version_id

obligatorio

string

Versión inmutable exacta de este activo. Combínala con asset_id para seleccionar los bytes retenidos; si falta la versión, nunca se recurre a la versión actual.

Patrón de validación (expresión regular)^[A-Za-z0-9_-]{21}[AQgw]$
asset.width
integer (mínimo exclusivo: 0, máximo: 9007199254740991)

Ancho de visualización en píxeles, después de aplicar la orientación EXIF, si se conoce.

asset.workspace

obligatorio

string (longitud mínima: 1)

Slug del Workspace al que pertenece este activo. Autentícate para el mismo Workspace al leerlo o gestionarlo.

message

obligatorio

string (longitud mínima: 1)
ok

obligatorio

string (siempre: "DAM_ASSET_FOUND")

Respuesta de error

Cuerpo de respuesta JSON. application/json text/plain; charset=utf-8

Esquema del cuerpo de la respuesta
JSON Schema completo

Abrir JSON en una pestaña nueva

Se requiere al menos una de estas propiedades: error, message, reason

La respuesta puede contener campos adicionales.

CampoTipo y descripción
assembly_id
string
error
string (longitud mínima: 1)
http_code
number | string
  • number
  • string
    Patrón de validación (expresión regular)^[\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

Explicación del error legible por humanos. Su redacción puede variar; usa el código error cuando manejes un fallo específico.

reason
null | string | number | boolean | Array<cualquier valor> | object

Puede aplicarse cualquiera de los esquemas siguientes:

null
string
number
boolean
Array<cualquier valor>
Array<cualquier valor>
Esquema de los elementos del array
cualquier valor
object
object
Esquema de propiedades adicionales
cualquier valor