Recuperar lista de Assemblies
Lista as Assemblies do Workspace autenticado.
https://api2.transloadit.com/ assembliesRecupera uma lista de Assemblies da sua conta. Elas são ordenadas por data de criação em ordem decrescente.
Exemplo de requisição
Execute esta requisição em um shell no lado do servidor com curl e um bearer token adequado em TRANSLOADIT_TOKEN. Se você precisar de um token, expanda a configuração abaixo.
Precisa de um bearer token?
Em um shell confiável no lado do servidor com curl e jq, defina TRANSLOADIT_KEY e TRANSLOADIT_SECRET com sua Auth Key e seu Auth Secret. Mantenha ambas as credenciais e o token resultante em segredo; nunca execute essa configuração em código de navegador.
Primeiro, crie um token com os escopos exigidos por este endpoint. Sua Auth Key já precisa conceder esses escopos.
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
Mantenha este shell aberto e execute a requisição abaixo. Reutilize o token enquanto ele continuar 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={}'
Autenticação
Este endpoint aceita params assinados ou um token bearer. Consulte Autenticação para instruções de configuração.
Escopo necessário para a Auth Key ou o token bearer: assemblies:read.
Requisições assinadas exigem tanto uma signature quanto um timestamp params.auth.expires no futuro. Tokens Bearer não exigem nenhum dos dois.
Parâmetros de consulta
params(string JSON). Um objeto codificado em JSON cujas chaves suportadas estão listadas abaixo.signature(string). Obrigatório para requisições assinadas. Omita este campo ao usar um bearer token.
Chaves suportadas dentro do campo params assinado
Os campos de autenticação desta lista se aplicam a requisições assinadas. Com um bearer token, você pode omitir params.auth e o campo signature separado. Compare os parâmetros de requisição específicos de autenticação abaixo.
Esquema JSON completo
params: Somente os campos listados para este objeto são aceitos.
| Campo | Tipo e descrição |
|---|---|
params. | stringRestringe os resultados a um Assembly ID. Padrão de validação (expressão regular)^[a-z0-9]{32}$ |
params.obrigatório para requisições assinadas; opcional com um bearer token | Contém a chave de API da Transloadit e os metadados de autenticação por assinatura de uma requisição de listagem de Assemblies.
|
params.obrigatório | stringTimestamp de expiração no formato ISO 8601 situado no futuro. Obrigatório quando uma requisição é assinada ou exige autenticação por assinatura; requisições autenticadas por bearer podem omiti-lo. |
params.obrigatório | stringChave de API da Transloadit usada para autenticar as requisições |
params. | string | integerValor único e aleatório incluído nos parâmetros da requisição assinada para tornar cada assinatura única e evitar a reutilização acidental de assinaturas. |
params. | stringEspecifica a data/hora UTC mínima de criação da Assembly. Apenas Assemblies posteriores a esse horário são retornadas. Use o formato |
params. | string | Array<string>Especifica uma expressão de busca diretamente ou como um array de strings cujos itens são unidos por vírgulas. Expressões renderizadas não em branco devem conter pelo menos três caracteres após a remoção de espaços. Ela corresponde a um Assembly ID ou a um prefixo de ID de seis caracteres, a um código de erro reconhecido ou (quando a busca por campos de Assembly está habilitada para o Workspace) ao nome ou valor exato de um campo personalizado. Se um código de erro reconhecido também corresponder ao nome ou ao valor de um campo personalizado, apenas as Assemblies que correspondem a ambos são retornadas. O padrão é nenhum filtro de palavra-chave. Qualquer um dos esquemas a seguir pode ser aplicado: stringstringPadrão de validação (expressão 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 do item do arraystring |
params. | string | integerValor único e aleatório incluído nos parâmetros da requisição assinada para tornar cada assinatura única e evitar a reutilização acidental de assinaturas. |
params. | "asc" | "desc"Especifica a direção da ordenação. O padrão é |
params. | integer (padrão: 1, mínimo: 1, máximo: 9007199254740991)Especifica a página atual dentro da paginação atual. O padrão é |
params. | integer (padrão: 50, mínimo: 1, máximo: 5000)Especifica quantas Assemblies devem ser retornadas por requisição de API. O padrão é |
params. | stringRestringe os resultados a uma região. A omissão, um valor composto apenas por espaços em branco ou Qualquer um dos esquemas a seguir pode ser aplicado: Variante 1: stringstringPadrão de validação (expressão 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: stringstringPadrão de validação (expressão 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 o campo usado para ordenar os resultados. O padrão é |
params. | stringRestringe os resultados a um Template ID ou nome. Use |
params. | stringEspecifica a data/hora UTC máxima de criação da Assembly. Apenas as Assemblies anteriores a esse horário são retornadas. Use o formato |
params. | "all" | "canceled" | "completed" | "executing" | "expired" | "failed" | "fixable" | "problematic" | "request_aborted" | "uploading"Especifica os tipos de Assemblies a serem recuperados. O padrão é |
Parâmetros de requisição por método de autenticação
Com parâmetros assinados
Inclua sua Auth Key como params.auth.key. Ao assinar a requisição, inclua um timestamp futuro em params.auth.expires e envie a assinatura no campo separado signature. As definições de campos abaixo usam caminhos dentro de params.
Esquema JSON completo
params: Somente os campos listados para este objeto são aceitos.
Usa as definições de campo acima: 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
Com um token bearer
Envie o token bearer no cabeçalho Authorization. Você pode omitir params.auth e o campo signature separado. Os demais parâmetros obrigatórios continuam se aplicando. As definições de campos abaixo usam caminhos dentro de params.
Esquema JSON completo
params: Somente os campos listados para este objeto são aceitos.
Usa as definições de campo acima: 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 e descrição |
|---|---|
params. | Contém a chave de API da Transloadit e os metadados de autenticação por assinatura de uma requisição de listagem de Assemblies.
|
params. | stringTimestamp de expiração no formato ISO 8601 situado no futuro. Obrigatório quando uma requisição é assinada ou exige autenticação por assinatura; requisições autenticadas por bearer podem omiti-lo. |
params. | stringChave de API da Transloadit usada para autenticar as requisições |
params. | string | integerValor único e aleatório incluído nos parâmetros da requisição assinada para tornar cada assinatura única e evitar a reutilização acidental de assinaturas. |
Resposta
Veja um exemplo de corpo de resposta:
{
"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
}
]
}sucesso 2xx
Corpo da resposta JSON. application/json text/plain; charset=utf-8
Esquema do corpo da resposta
Esquema JSON completo
A resposta pode conter campos adicionais.
| Campo | Tipo e descrição | ||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
countobrigatório | integer (mínimo: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
itemsobrigatório | Array<object>Esquema do item do array
|
Resposta de erro
Corpo da resposta JSON. application/json text/plain; charset=utf-8
Esquema do corpo da resposta
Esquema JSON completo
A resposta pode conter campos adicionais.
| Campo | Tipo e descrição |
|---|---|
assembly_id | string |
error | string (comprimento mínimo: 1) |
http_code | number | string
|
message | stringExplicação do erro legível por humanos. A redação pode variar; use o código |
reason | null | string | number | boolean | Array<qualquer valor> | objectQualquer um dos esquemas a seguir pode ser aplicado: nullnullstringstringnumbernumberbooleanbooleanArray<qualquer valor>Array<qualquer valor>Esquema do item do arrayqualquer valorobjectobjectEsquema de propriedade adicionalqualquer valor |
HTTP 400
Corpo da resposta JSON. application/json text/plain; charset=utf-8
Esquema do corpo da resposta
Esquema JSON completo
Erros nomeados e o formato geral de erro
error: "ASSEMBLY_LIST_ERROR"
Parâmetros inválidos.
A resposta pode conter campos adicionais.