Recuperar la lista de Assemblies
Enumera las Assemblies del Workspace autenticado.
https://api2.transloadit.com/ assembliesObtiene una lista de Assemblies de tu cuenta. Se ordenan por fecha de creación en orden descendente.
Ejemplo de solicitud
Ejecuta esta solicitud en una consola del lado del servidor con curl y un token Bearer adecuado en TRANSLOADIT_TOKEN. Si necesitas un token, despliega la configuración que aparece a continuación.
¿Necesitas un token Bearer?
En una consola de confianza del lado del servidor con curl y jq, asigna a TRANSLOADIT_KEY y TRANSLOADIT_SECRET los valores de tu Auth Key y tu Auth Secret. 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=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
Mantén abierta esta consola y ejecuta la solicitud que aparece a continuación. Reutiliza el token mientras siga siendo válido.
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={}'
Autenticación
Este endpoint acepta params firmados o un token Bearer. Consulta Autenticación para ver las instrucciones de configuración.
Ámbito requerido para el Auth Key o el token de portador: assemblies:read.
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 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
params: Solo se aceptan los campos enumerados para este objeto.
| Campo | Tipo y descripción |
|---|---|
params. | stringRestringe los resultados a un único ID de Assembly. Patrón de validación (expresión regular)^[a-z0-9]{32}$ |
params.obligatorio para las solicitudes firmadas; opcional con un token Bearer | Contiene la clave de API de Transloadit y los metadatos de Signature Authentication para una solicitud de listado de Assemblies.
|
params.obligatorio | stringMarca 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.obligatorio | stringClave de API de Transloadit utilizada para autenticar solicitudes |
params. | stringEspecifica la fecha y hora UTC mínima de creación de Assemblies. Solo se devuelven las Assemblies posteriores a ese momento. Usa el formato |
params. | string | Array<string>Especifica una expresión de búsqueda directamente o como un array de cadenas cuyos elementos se unen con comas. Las expresiones resultantes que no estén en blanco deben contener al menos tres caracteres después de eliminar los espacios en blanco al principio y al final. La expresión coincide con el ID de una Assembly o un prefijo de ID de seis caracteres, un código de error reconocido o (cuando la búsqueda por campos de las Assemblies está habilitada para el Workspace) un nombre o valor exacto de un campo personalizado. Si un código de error reconocido también coincide con un nombre o valor de un campo personalizado, solo se devuelven las Assemblies que coincidan con ambos. Por defecto, no se aplica ningún filtro por palabra clave. Puede aplicarse cualquiera de los esquemas siguientes: stringstringPatró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]*|[\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>Esquema de los elementos del arraystring |
params. | string | integerValor 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. | "asc" | "desc"Especifica la dirección de ordenación. El valor predeterminado es |
params. | integer (valor predeterminado: 1, mínimo: 1, máximo: 9007199254740991)Especifica la página actual dentro de la paginación en curso. El valor predeterminado es |
params. | integer (valor predeterminado: 50, mínimo: 1, máximo: 5000)Especifica cuántas Assemblies se devuelven por solicitud a la API. El valor predeterminado es |
params. | stringRestringe los resultados a una región. Un valor omitido, compuesto solo por espacios en blanco o igual a Puede aplicarse cualquiera de los esquemas siguientes: Variante 1: stringstringPatró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]*$Variante 2: stringstringPatró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]*[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"Especifica el campo utilizado para ordenar los resultados. El valor predeterminado es |
params. | stringRestringe los resultados a un ID o nombre de Template. Usa |
params. | stringEspecifica la fecha y hora UTC máxima de creación de Assemblies. Solo se devuelven las Assemblies anteriores a ese momento. Usa el formato |
params. | stringEspecifica los tipos de Assemblies que se recuperarán. El valor predeterminado es Valores permitidos (10)
|
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
params: Solo se aceptan los campos enumerados para este objeto.
Utiliza las definiciones de campos indicadas arriba: 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
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
params: Solo se aceptan los campos enumerados para este objeto.
Utiliza las definiciones de campos indicadas arriba: 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
| Campo | Tipo y descripción |
|---|---|
params. | Contiene la clave de API de Transloadit y los metadatos de Signature Authentication para una solicitud de listado de Assemblies.
|
params. | stringMarca 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. | stringClave de API de Transloadit utilizada para autenticar solicitudes |
Respuesta
Este es un ejemplo del cuerpo de la respuesta:
{
"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
}
]
}éxito 2xx
Cuerpo de respuesta JSON. application/json text/plain; charset=utf-8
Esquema del cuerpo de la respuesta
JSON Schema completo
La respuesta puede contener campos adicionales.
| Campo | Tipo y descripción | ||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
countobligatorio | integer (mínimo: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
itemsobligatorio | Array<object>Esquema de los elementos del array
|
Respuesta de error
Cuerpo de respuesta JSON. application/json text/plain; charset=utf-8
Esquema del cuerpo de la respuesta
JSON Schema completo
La respuesta puede contener campos adicionales.
| Campo | Tipo y descripción |
|---|---|
assembly_id | string |
error | string (longitud mínima: 1) |
http_code | number | string
|
message | stringExplicación del error legible por humanos. Su redacción puede variar; usa el código |
reason | null | string | number | boolean | Array<cualquier valor> | objectPuede aplicarse cualquiera de los esquemas siguientes: nullstringnumberbooleanArray<cualquier valor>Array<cualquier valor>Esquema de los elementos del arraycualquier valorobjectobjectEsquema de propiedades adicionalescualquier valor |
HTTP 400
Cuerpo de respuesta JSON. application/json text/plain; charset=utf-8
Esquema del cuerpo de la respuesta
JSON Schema completo
Errores con nombre y el formato general de error
error: "ASSEMBLY_LIST_ERROR"
Parámetros incorrectos.
La respuesta puede contener campos adicionales.