Récupérer la liste des Assemblies
Liste les Assemblies du Workspace authentifié.
https://api2.transloadit.com/ assembliesRécupère une liste des Assemblies de votre compte. Elles sont triées par date de création décroissante.
Exemple de requête
Exécutez cette requête dans un shell côté serveur avec curl et un jeton porteur approprié dans TRANSLOADIT_TOKEN. Si vous avez besoin d’un jeton, développez la section de configuration ci-dessous.
Besoin d’un jeton porteur ?
Dans un shell de confiance côté serveur disposant de curl et de jq, définissez TRANSLOADIT_KEY et TRANSLOADIT_SECRET sur les valeurs de votre Auth Key et de votre Auth Secret. Gardez confidentiels les deux informations d’identification et le jeton obtenu ; n’exécutez jamais cette configuration dans du code de navigateur.
Commencez par créer un jeton avec les portées requises par ce point de terminaison. Votre Auth Key doit déjà accorder ces portées.
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
Gardez ce shell ouvert et exécutez la requête ci-dessous. Réutilisez le jeton tant qu’il reste valide.
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={}'
Authentification
Ce point de terminaison accepte des params signés ou un jeton porteur. Consultez la section Authentification pour les instructions de configuration.
Portée requise pour l’Auth Key ou le jeton porteur : assemblies:read.
Les requêtes signées nécessitent à la fois une signature et un horodatage params.auth.expires situé dans le futur. Les jetons porteurs ne nécessitent ni l’un ni l’autre.
Paramètres de requête
params(Chaîne JSON). Un objet encodé en JSON dont les clés prises en charge sont répertoriées ci-dessous.signature(chaîne de caractères). Obligatoire pour les requêtes signées. Omettez ce champ lorsque vous utilisez un jeton porteur.
Clés prises en charge dans le champ signé params
Les champs d’authentification de cette liste s’appliquent aux requêtes signées. Avec un jeton porteur, vous pouvez omettre params.auth et le champ distinct signature. Comparez les paramètres de requête spécifiques à l’authentification ci-dessous.
Schéma JSON complet
params: Seuls les champs répertoriés pour cet objet sont acceptés.
| Champ | Type et description |
|---|---|
params. | stringLimite les résultats à un seul identifiant d’Assembly. Motif de validation (expression régulière)^[a-z0-9]{32}$ |
params.obligatoire pour les requêtes signées ; facultatif avec un jeton porteur | Contient la clé API Transloadit et les métadonnées de Signature Authentication pour une requête visant à lister les Assemblies.
|
params.obligatoire | stringHorodatage d’expiration au format ISO 8601 situé dans le futur. Obligatoire lorsqu’une requête est signée ou nécessite Signature Authentication ; les requêtes authentifiées par jeton porteur peuvent l’omettre. |
params.obligatoire | stringClé API Transloadit utilisée pour authentifier les requêtes |
params. | stringIndique la date et l’heure UTC minimales de création de l’Assembly. Seules les Assemblies postérieures à ce moment sont renvoyées. Utilisez le format |
params. | string | Array<string>Spécifie une expression de recherche directement ou sous la forme d’un tableau de chaînes dont les éléments sont joints par des virgules. Après suppression des espaces en début et en fin, les expressions résultantes non vides doivent contenir au moins trois caractères. L’expression correspond à un ID d’Assembly ou à un préfixe d’ID de six caractères, à un code d’erreur reconnu ou (lorsque la recherche dans les champs des Assemblies est activée pour le Workspace) à un nom ou à une valeur de champ personnalisé par correspondance exacte. Si un code d’erreur reconnu correspond également à un nom ou à une valeur de champ personnalisé, seules les Assemblies correspondant aux deux sont renvoyées. Par défaut, aucun filtre par mot-clé n’est appliqué. N’importe lequel des schémas suivants peut s’appliquer : stringstringMotif de validation (expression régulière)^(?:[\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>Schéma d’un élément de tableaustring |
params. | string | integerValeur unique et aléatoire incluse dans les paramètres de la requête signée pour rendre chaque signature unique et empêcher la réutilisation accidentelle d’une signature. |
params. | "asc" | "desc"Indique le sens du tri. La valeur par défaut est |
params. | integer (par défaut : 1, minimum : 1, maximum : 9007199254740991)Indique la page actuelle dans la pagination en cours. La valeur par défaut est |
params. | integer (par défaut : 50, minimum : 1, maximum : 5000)Indique le nombre d’Assemblies à renvoyer par requête API. La valeur par défaut est |
params. | stringLimite les résultats à une région. Si le paramètre est omis, si sa valeur ne contient que des caractères d’espacement ou si elle vaut N’importe lequel des schémas suivants peut s’appliquer : Variante 1: stringstringMotif de validation (expression régulière)^[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*$Variante 2: stringstringMotif de validation (expression régulière)^[\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"Indique le champ utilisé pour trier les résultats. La valeur par défaut est |
params. | stringLimite les résultats à un ID de Template ou à un nom de Template. Utilisez |
params. | stringSpécifie la date et l’heure UTC maximales de création des Assemblies. Seules les Assemblies créées avant cet instant sont renvoyées. Utilisez le format |
params. | stringSpécifie les types d’Assemblies à récupérer. La valeur par défaut est Valeurs autorisées (10)
|
Paramètres de requête par méthode d’authentification
Avec des paramètres signés
Incluez votre Auth Key dans params.auth.key. Lors de la signature de la requête, incluez un horodatage futur dans params.auth.expires et envoyez la signature dans le champ distinct signature. Les définitions des champs ci-dessous utilisent des chemins à l’intérieur de params.
Schéma JSON complet
params: Seuls les champs répertoriés pour cet objet sont acceptés.
Utilise les définitions des champs ci-dessus : 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
Avec un jeton porteur
Envoyez le jeton porteur dans l’en-tête Authorization. Vous pouvez omettre params.auth et le champ distinct signature. Les autres paramètres obligatoires restent requis. Les définitions des champs ci-dessous utilisent des chemins à l’intérieur de params.
Schéma JSON complet
params: Seuls les champs répertoriés pour cet objet sont acceptés.
Utilise les définitions des champs ci-dessus : 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
| Champ | Type et description |
|---|---|
params. | Contient la clé API Transloadit et les métadonnées de Signature Authentication pour une requête visant à lister les Assemblies.
|
params. | stringHorodatage d’expiration au format ISO 8601 situé dans le futur. Obligatoire lorsqu’une requête est signée ou nécessite Signature Authentication ; les requêtes authentifiées par jeton porteur peuvent l’omettre. |
params. | stringClé API Transloadit utilisée pour authentifier les requêtes |
Réponse
Voici un exemple de corps de réponse :
{
"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
}
]
}Succès 2xx
Corps de la réponse JSON. application/json text/plain; charset=utf-8
Schéma du corps de la réponse
Schéma JSON complet
La réponse peut contenir des champs supplémentaires.
| Champ | Type et description | ||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
countobligatoire | integer (minimum : 0) | ||||||||||||||||||||||||||||||||||||||||||||||
itemsobligatoire | Array<object>Schéma d’un élément de tableau
|
Réponse d’erreur
Corps de la réponse JSON. application/json text/plain; charset=utf-8
Schéma du corps de la réponse
Schéma JSON complet
La réponse peut contenir des champs supplémentaires.
| Champ | Type et description |
|---|---|
assembly_id | string |
error | string (longueur minimale : 1) |
http_code | number | string
|
message | stringExplication de l’erreur destinée à être lue par un humain. Sa formulation peut varier ; utilisez le code |
reason | null | string | number | boolean | Array<n’importe quelle valeur> | objectN’importe lequel des schémas suivants peut s’appliquer : nullstringnumberbooleanArray<n’importe quelle valeur>Array<n’importe quelle valeur>Schéma d’un élément de tableaun’importe quelle valeurobjectobjectSchéma de la propriété supplémentairen’importe quelle valeur |
HTTP 400
Corps de la réponse JSON. application/json text/plain; charset=utf-8
Schéma du corps de la réponse
Schéma JSON complet
Erreurs nommées et format général des erreurs
error: "ASSEMBLY_LIST_ERROR"
Paramètres incorrects.
La réponse peut contenir des champs supplémentaires.