Créer une définition d'API - Cloud

Guide d'utilisation des API Talend Cloud

Version
Cloud
Language
Français (France)
Product
Talend Cloud
Module
Talend API Designer
Talend API Tester
Talend Data Preparation
Talend Data Stewardship
Talend Management Console
Content
Création et développement > Création d'APIs
Création et développement > Test d'API

Utilisez la méthode POST sur l'endpoint /api-definitions pour importer une définition d'API dans Talend Cloud API Designer.

Avant de commencer

Vous avez généré un jeton d'accès personnel. Pour plus d'informations, consultez Générer un jeton d'accès personnel.

Procédure

  1. Ouvrez Talend Cloud API Tester et créez une requête.
  2. Dans la liste déroulante METHOD, sélectionnez POST.
  3. Saisissez l'URI ci-dessous en utilisant le paramètre de région approprié :
    https://apid.{region}.cloud.talend.com/api/v1/api-definitions
    La région peut être :
    • us-west
    • us
    • eu
    • ap
    • AT

    Pour plus d'informations, consultez URL et régions de Talend Cloud.

  4. Facultatif : Développez QUERY PARAMETERS et cliquez sur Add query parameters.
    Les paramètres disponibles sont les suivants :
    Paramètre Description
    format Format de la définition d'API à importer. La valeur peut être :
    • OpenApi3 (valeur par défaut)
    • Swagger20
    • Swagger12
    • Raml10
    • Raml08
    failOnWarnings Indique si vous souhaitez arréter le processus au premier avertissement sur la transformation du modèle. Sa valeur peut être true ou false. La valeur par défaut est false.
    mainFile Si vous importer une définition d'API contenant plusieurs fichier dans une même archive, saisissez le nom du fichier de définition principal.
  5. Cliquez sur le bouton Add header, saisissez Authorization dans le champ name et Bearer suivi d'un espace, puis de votre jeton, dans le champ value.
    Conseil : Dans Talend Cloud API Tester, vous pouvez ajouter votre jeton comme variable d'environnement privée et y faire référence dans vos requêtes, à l'aide de l'Expression Builder. Pour plus d'informations, consultez Utiliser des environnements.
  6. Facultatif : Modifiez l'en-tête Content-Type.
    Par défaut, Talend Cloud API Tester ajoute un en-tête Content-Type contenant la valeur application/json des requêtes POST. Si vous voulez importer vôtre définition en tant que fichier YAML ou .zip, modifier cette valeur en application/x-yaml ou en application/zip.
  7. Ajoutez vôtre définition d'API :
    • Saisissez la définition dans la zone de texte BODY.
    • Cliquez sur la liste déroulante Text située au dessus du corps de la requête et sélectionnez File. Parcourez ensuite le système jusqu'au fichier, ou effectuez un glisser-déposer.
  8. Une fois votre requête configurée, cliquez sur Send.

Résultats

La définition d'API est créée dans Talend Cloud API Designer. La réponse retournée contient les identifiants de l'API et d'autres métadonnées, comme l'identifiant de l'auteur ou la date de création.