Skip to main content

Comment utiliser Postman

Vous pouvez utiliser Postman pour tester l'API Server V3.

Conditions préalables :

Ajout de l'API à Postman

Pour tester l'API Server, importez-la dans Postman.

  • Tout d'abord, récupérez le lien que vous utiliserez pour importer l'API Server V3. Pour trouver ce lien, accédez à l'interface utilisateur Server, sélectionnez l'icône en forme de point d'interrogation dans le coin supérieur droit, puis sélectionnez Documentation sur l'API . Vous accédez ainsi à la page API V3 de Swagger.

  • Notez l'adresse de la documentation sur l'API que vous trouverez sur la page de Swagger.

    Note the address of the API documentation you find on the Swagger page. 

  1. Dans Postman, accédez à Collections , puis sélectionnez Importer .

  2. Sélectionnez Lien , saisissez l'URL de l'API Server que vous avez notée à l'étape 2 , puis sélectionnez Continuer .

  3. L'API Alteryx Server V3 apparaît désormais dans l'onglet Collections .

Configuration de l'autorisation

Pour envoyer vos requêtes, configurez votre autorisation dans Postman.

  • Accédez à Collections et sélectionnez l' API Alteryx Server V3 .

  • Dans l'onglet Autorisations , définissez le type sur OAuth 2.0 .

  • Configurez le jeton actuel comme suit :

    AD273A073BE2399E360B94B3F9EB79C6.png

  1. Dans la section Configurer un nouveau jeton , configurez les éléments suivants :

    1. Vous pouvez également saisir un nom de jeton .

    2. Dans le champ Type d'octroi , sélectionnez Identifiants client .

    3. Dans le champ URL du jeton d'accès , saisissez le point de terminaison du serveur d'authentification. Pour obtenir le point de terminaison, accédez à Swagger et recherchez l' URL du jeton . Pour plus d'informations, consultez la section Authentification de la page d'aide Configuration et autorisation de l'API .Configuration et autorisation de l'API Server

      Find the Token URL in Swagger.

      Exemple de la configuration finale du jeton :

      How the API authorization looks like in Postman.

    4. Dans le champ ID client , saisissez la clé d'accès à l'API , disponible dans Mon profil dans l'interface utilisateur Server.

    5. Dans le champ Secret client , saisissez le secret de l'API , disponible dans Mon profil dans l'interface utilisateur Server.

    6. Dans le champ Authentification client , sélectionnez Envoyer en tant qu'en-tête d'authentification de base .

  2. Sélectionnez Obtenir un nouveau jeton d'accès .

Configuration de l'environnement

Définissez les mêmes valeurs dans Environnement .

  1. Cliquez sur l'icône en forme d'œil dans le coin supérieur droit, puis sélectionnez Ajouter .

  2. Saisissez le nom de votre environnement.

  3. Saisissez la même URL de base, la même clé API et le même secret API qu'à l'étape 4 de la section Configuration de l'autorisation.

  4. Saisissez l'URL de votre environnement. Elle est disponible dans Paramètres système Alteryx en tant qu' adresse de base . Voir l'étape 4 de la section Configuration de l'autorisation.

  5. Sélectionnez Enregistrer .

Envi de requêtes

Vous pouvez tester l'API Server dans Postman, autoriser vos requêtes, les envoyer ou explorer différents types de codes pour celles-ci.

Exemple

Imaginons que vous souhaitez récupérer la liste des actifs d'un utilisateur.

  1. Tout d'abord, vous devez connaître l'ID utilisateur.

    1. Accédez à Collections , puis sélectionnez API Alteryx Server V3 .

    2. Sélectionnez Utilisateurs , puis cliquez sur Recherche GET des enregistrements utilisateurs .

    3. Dans l'onglet Paramètres , les options définies peuvent vous aider à effectuer des recherches dans tous les enregistrements utilisateurs.

    4. Pour envoyer la requête, sélectionnez Envoyer . Vous obtiendrez des résultats basés sur les paramètres que vous avez saisis.

    5. Parmi les résultats, copiez l'ID de l'utilisateur dont vous souhaitez récupérer la liste d'actifs.

  2. Dans un autre onglet, ouvrez une nouvelle requête. Accédez à Utilisateurs , puis sélectionnez {id} .

  3. Sélectionnez Récupération GET de la liste complète des actifs d'un utilisateur . Saisissez l'ID utilisateur obtenu lors de la requête précédente pour obtenir la liste de ses actifs.

EF76F0DE8E6C3302DC8217A5E26730F2.png

Note

Lorsque vous envoyez une requête via Postman, n'oubliez pas de l'autoriser. Pour autoriser votre requête, 2 options existent :

  • Dans le champ Type , cliquez sur OAuth2 , puis sélectionnez l'un de vos jetons disponibles.

  • Dans le champ Type , cliquez sur Hériter l'autorisation du parent . L'autorisation que vous avez configurée pour l'ensemble de la collection sera utilisée.

Dans cette section​: