Récupérer une définition d'API pour AWS API Gateway | Aide Qlik Cloud
Accéder au contenu principal

Récupérer une définition d'API pour AWS API Gateway

Exportez une définition d'API sous forme de fichier JSON compatible avec AWS API Gateway depuis API Designer.

  • Vous avez installé cURL. Pour plus d'informations, consultez la documentation cURL.
  • Vous avez créé une API dans API Designer.
  1. Ouvrez une invite de commande et entrez la commande suivante afin d'exporter votre définition d'API.
    curl --header "Authorization:Bearer {userToken}" -X GET -o {outFile}.json https://apid.{region}.cloud.talend.com/api/v1/api-definitions/{api-id}?format=OpenApi3Aws
  2. Ajoutez les paramètres adéquats :
    ParamètreDescription
    {userToken}Jeton généré à partir de Qlik Talend Cloud.
    {outFile}Chemin d'accès et nom de fichier de votre définition d'API. Par exemple : contactsapi.json
    {region}Région de votre compte Qlik Talend Cloud. La valeur peut être :
    • us-west
    • us
    • eu
    • ap
    • au

    Pour plus d'informations, consultez Accéder aux applications Talend Cloud.

    {api-id}ID de la version de l'API à récupérer. Pour le récupérer, ouvrez votre API dans API Designer et accédez à Settings (Paramètres) MANAGEMENT API ou utilisez la méthode GET sur le point de terminaison /api-definitions pour obtenir une liste de définitions d'API avec leur ID.
  3. Exécutez la commande.

Votre définition d'API est exportée sous forme de fichier JSON compatible avec AWS API Gateway et enregistrée dans le répertoire sélectionné.

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.