Recuperar lista de Templates
Lista os Templates disponíveis para o Workspace autenticado.
https://api2.transloadit.com/ templatesUse include_builtin=exclusively-latest para obter o catálogo atual de Builtins, ou
exclusively-all para obter todas as versões. Cada Builtin inclui seu name, builtin_version,
description e fields_schema, um JSON Schema draft-07 independente derivado do
validador de campos usado em tempo de execução. Os Builtins com um summary descrevem seu resultado em um único
parágrafo autossuficiente, adequado para listas de ferramentas. Passe o id versionado como template_id
ao criar uma Assembly.
Valide os campos efetivos depois de mesclar os valores padrão de content.fields com os campos que você fornecer.
fields_schema: null significa que um Builtin legado não tem um validador de campos declarado; os Templates
de Workspace omitem essa propriedade. Uma anotação x-transloadit-input-fidelity: conservative
marca restrições que o JSON Schema representa apenas de forma aproximada. A validação em tempo de execução continua sendo a referência definitiva.
Exemplo de requisição
Workspaces cancelados não podem criar novos tokens bearer. Este endpoint continua disponível com uma Auth Key ativa existente: use a receita de leitura assinada em vez da configuração de token abaixo. A chave precisa conceder os escopos exigidos por este endpoint.
Execute esta requisição em um shell no servidor com curl e um token bearer adequado em TRANSLOADIT_TOKEN. Se precisar de um token, expanda a configuração abaixo.
Precisa de um token bearer?
Em um shell confiável no servidor com curl e jq, defina TRANSLOADIT_KEY e TRANSLOADIT_SECRET com sua Auth Key e seu Auth Secret. Mantenha em segredo as duas credenciais e o token resultante; nunca execute esta 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=templates: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/templates" \
--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: templates: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.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 para uma requisição de Template.
|
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. | stringEspecifica a data/hora mínima de criação em UTC para os Templates do Workspace. Somente os Templates do Workspace criados nesse horário ou depois dele são retornados; os Builtin Templates não são filtrados por data de criação. Use um timestamp UTC como |
params. | "all" | "exclusively-all" | "exclusively-latest" | "latest" | "none" (padrão: "none")Controla se os Builtin Templates são incluídos. Use |
params. | string | Array<string> (padrão: "")Filtra os nomes de Templates do Workspace usando um padrão SQL LIKE delimitado por Qualquer um dos esquemas a seguir pode ser aplicado: stringArray<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" (padrão: "desc")Especifica a direção de ordenação dos Templates do Workspace. Não altera a ordenação dos Builtin Templates. 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: 850, mínimo: 1, máximo: 850)Especifica quantos Templates retornar por requisição de API. O padrão é |
params. | "created" | "id" | "last_used" | "modified" | "name" (padrão: "created")Especifica o campo usado para ordenar os Templates do Workspace. Não altera a ordenação dos Builtin Templates. O padrão é |
params. | stringEspecifica a data/hora UTC máxima de criação para Templates de Workspace. Somente Templates de Workspace criados nesse horário ou antes dele são retornados; Builtin Templates não são filtrados por data de criação. Use um timestamp UTC como |
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.auth, params.fromdate, params.include_builtin, params.keywords, params.nonce, params.order, params.page, params.pagesize, params.sort, params.todate
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.fromdate, params.include_builtin, params.keywords, params.nonce, params.order, params.page, params.pagesize, params.sort, params.todate
| Campo | Tipo e descrição |
|---|---|
params. | Contém a chave de API da Transloadit e os metadados de autenticação por assinatura para uma requisição de Template.
|
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 |
Resposta
sucesso 2xx
Corpo da resposta JSON. application/json text/plain; charset=utf-8
Esquema do corpo da resposta
Esquema JSON completo
A resposta contém apenas os campos listados para este objeto.
| 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: nullstringnumberbooleanArray<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: "TEMPLATE_LIST_ERROR"
Parâmetros inválidos.
A resposta pode conter campos adicionais.