Récupérer les types d’informations d’identification de Template
Répertorie les types d’informations d’identification de Template pris en charge par Transloadit.
https://api2.transloadit.com/ template_credentials/ typesExécutez l’exemple de requête ci-dessous pour découvrir les champs actuels des services. Dans la réponse,
sélectionnez votre service sous types, puis examinez types[service].fields.
Par exemple, types.s3.fields décrit les champs acceptés pour les informations d’identification S3.
Utilisez ces noms de champs dans l’objet content lors de la création ou de la mise à jour des informations d’identification.
Un champ dont requiredOnCreate vaut true doit avoir une valeur non vide lors de la création des informations d’identification.
Un champ dont requiredOnUpdate vaut true doit avoir une valeur non vide chaque fois que vous fournissez
content lors d’une mise à jour. Si l’un de ces indicateurs est absent ou vaut false, le champ concerné n’est pas obligatoire pour
l’opération correspondante. Consultez la section Mise à jour des informations d’identification
pour connaître le comportement en cas d’omission de content et les règles de préservation des secrets.
Le schéma téléchargeable décrit la structure de cette réponse, et non le catalogue actuel des services ; la réponse à la requête de découverte authentifiée fournit les noms des champs, leurs explications et leurs exigences.
Exemple de requête
Les Workspaces résiliés ne peuvent pas créer de nouveaux jetons porteurs. Ce point de terminaison reste accessible avec une Auth Key active existante : utilisez la procédure de lecture signée à la place de la configuration du jeton ci-dessous. La clé doit accorder les portées requises par ce point de terminaison.
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 avec votre Auth Key et votre Auth Secret. Gardez ces deux informations d’identification et le jeton obtenu secrets ; n’exécutez jamais cette configuration dans du code de navigateur.
Ce point de terminaison n’exige aucune portée spécifique. Le jeton ci-dessous hérite des portées de votre Auth Key.
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')"; 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/template_credentials/types" \
--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.
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.obligatoire pour les requêtes signées ; facultatif avec un jeton porteur | Contient la clé d’API Transloadit et les métadonnées d’authentification par signature d’une requête portant sur les informations d’identification de Template.
|
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. | 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. |
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.auth, params.nonce
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.nonce
| Champ | Type et description |
|---|---|
params. | Contient la clé d’API Transloadit et les métadonnées d’authentification par signature d’une requête portant sur les informations d’identification de Template.
|
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
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 |
|---|---|
messageobligatoire | string (longueur minimale : 1) |
okobligatoire | string (toujours : "TEMPLATE_CREDENTIALS_TYPES_FOUND") |
typesobligatoire | objectSchéma de la propriété supplémentaireobject (propriétés requises : fields)Des détails supplémentaires sur le schéma sont disponibles dans le schéma JSON complet. |
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 |