Didacticiel : S'abonner àAWS Data Exchangepour API (produit de test) surAWS Data Exchange

AWS Data Exchangefor API (Test Product) est un produit gratuit mis à la disposition des abonnés afin de comprendre comment interagir avec unAWS Data Exchangeproduit contenant des ensembles de données API. Vous pouvez utiliser ce produit à des fins de test et d'apprendre comment passer des appels API à des fournisseurs afin de récupérer des données basées sur des API.

AWS Data Exchangefor API (Test Product) contient un ensemble de données d'API nomméAWS Data Exchangepour API (produit de test)qui se trouve dans la région USA Est (Virginie du Nord).

Abonnement àAWS Data Exchangepour API (produit de test) surAWS Data Exchange

La procédure suivante montre comment naviguer dans laAWS Data Exchangecatalogue pour trouver et s'abonnerAWS Data Exchangepour les API (produit de test).

Pour trouver et s'abonner àAWS Data Exchangepour API (produit de test)

1. Ouvrez et connectez-vous auAWS Data Exchangeconsole.

2. Dans le volet de navigation de gauche, sousDécouvrez les produits de données, choisissezParcourir le catalogue.

3. Dans la barre de recherche, saisissezAWS Data Exchange for APIset appuyez surSaisissez.

4. Cliquez sur l'ongletAWS Data Exchangepour API (produit de test)et affichez sa page de détails.

   1. (Facultatif) Pour télécharger l'échantillon, choisissez leDictionnaire de données et exemples, sélectionnez la case d'option en regard du nom de l'échantillon (ADX pour API sample.json), puis choisissezTéléchargement.

5. Dans le coin supérieur droit, choisissezContinuer à vous abonner.

6. Cliquez sur l'ongletOffre de produits.

   Note

   AWS Data Exchangefor API (Test Product) est un produit gratuit.

7. Vérifiez laConditions d'abonnement,Ensembles de données, etInformations sur l'Support.

8. Choisissez d'activer ou nonOffre de renouvellement automatiquepour l'abonnement.

   Note

   AWS Data Exchangepour les API (Test Product) ne nécessite pas de vérification de l'abonnement, mais certains produits le font. Pour plus d'informations, consultez Vérification de l'abonnement pour les abonnés.

9. Choisissez Subscribe.

Il peut s'écouler quelques minutes avant que votre abonnement ne devienne actif après votre choix.S'abonner. La navigation loin de cette page avant que votre abonnement ne devienne actif n'empêchera pas le traitement de l'abonnement.

A l'aide deAWS Data Exchangepour API (produit de test)

Vous pouvez interagir avecAWS Data Exchangepour API (produit de test) de la manière suivante :

Affichage de l'API

Pour afficher l'API

1. Ouvrez et connectez-vous auAWS Data Exchangeconsole.

2. Dans le volet de navigation de gauche, sousMes abonnements, choisissezDonnées autorisées.

3. Choisissez le produit intituléAWS Data Exchangepour API (produit de test)puis choisissez laAWS Data Exchangepour APIensemble de données.

4. SousRévisions, choisissez une révision.

5. UNDERRessource d'API, choisissez l'API.

6. Affichage duPrésentation des assets.

7. Suivez les instructions fournies dans laRemarque d'intégrationpour appeler l'API.

Téléchargement de la spécification de l'API

Pour télécharger la spécification de l'API

1. Ouvrez et connectez-vous auAWS Data Exchangeconsole.

2. Dans le volet de navigation de gauche, sousMes abonnements, choisissezDonnées autorisées.

3. Choisissez le produit intituléAWS Data Exchangepour API (produit de test)puis choisissez laAWS Data Exchangepour APIensemble de données.

4. SousRévisions, choisissez une révision.

5. UNDERRessource d'API, choisissez l'API.

6. Dans la pageSpécification OpenAPI 3.0, choisissezTélécharger la spécification d'API.

   La spécification est téléchargée sur votre ordinateur local. Vous pouvez ensuite exporter la ressource vers un outil tiers pour la génération de SDK.

Passer un appel API

Vous pouvez appeler un point de terminaison unique dans leAWS Data Exchangeconsole

Pour passer un appel d'API depuis la console

1. Ouvrez et connectez-vous auAWS Data Exchangeconsole.

2. Sous le volet de navigation de gauche, sousMes abonnements, choisissezDonnées autorisées.

3. Choisissez le produit intituléAWS Data Exchangepour API (produit de test)puis choisissez laAWS Data Exchangepour APIensemble de données.

4. SousRévisions, choisissez la révision.

5. UNDERRessource d'API, choisissez l'API.

   Vous verrez l'échantillonStructure des codesetSpécification OpenAPI 3.0pour structurer votre demande d'API, que vous pouvez utiliser dans leAWS Command Line Interfacepour appeler l'API.

6. UNDERRemarque d'intégration, choisissezCopierpour copier laStructure des codespuis collez-le dansAWS CLI.

7. Remplacez les valeurs d'échantillon par les paires clé-valeur de paramètre dont vous avez besoin à l'aide des informations de la documentation de spécification.

   Voici un exemple de demande d'API pourAWS Data Exchangepour API (produit de test).

   aws dataexchange send-api-asset \
     --data-set-id 8d494cba5e4720e5f6072e280daf70a8 \
     --revision-id b655d5be3da04fcbdca21a5a2932d789 \
     --asset-id 8550cfab16b444a794402f2c3f11eae1 \
     --method POST \
     --path "someresource" \
     --query-string-parameters 'param1=value1,param2=value2' \
     --request-headers 'header=header_value' \
     --body "{\"body_param\":\"body_param_value\"}"