Outil API Server
Utilisez l'outil API Server pour interagir avec l'API Server (v1, v2 et v3) sans avoir besoin d'écrire un workflow complexe. Pour en savoir plus sur l'accès à l'outil API Server, l'authentification, les points de terminaison, les paramètres et les versions, accédez à la page Présentation de l'outil API Server.
Astuce
Cet outil n’est pas automatiquement installé avec Alteryx Designer. Pour utiliser cet outil, téléchargez-le depuis Alteryx Marketplace.
L'outil API Server est compatible avec Designer et Server version 2021.4 et ultérieure. Notez que certaines fonctionnalités de l'outil peuvent être limitées en fonction de votre version de Server.
Compatible avec Alteryx Multi-threaded Processing (AMP) et le moteur d'origine.
L'outil API Server n'est actuellement pas pris en charge avec le mode DCM uniquement du gestionnaire de connexion aux données.
L'outil API Server nécessite que les packages suivants soient installés sur votre ordinateur :
oauthlibrequests_oauthlib
Si ces packages ne sont pas installés…
Ajoutez l'outil API Server au canevas de votre workflow et exécutez celui-ci. S'il manque un package, l'outil génère une erreur.
Accédez à la fenêtre Résultats du workflow et sélectionnez l'onglet Tout (ou l'onglet Fichiers pour réduire la liste des éléments).
Localisez et sélectionnez le message « Exécutez ce workflow lié en tant qu'administrateur pour installer les packages manquants ». Cela ouvre un nouveau workflow avec un outil Python préconfiguré pour installer les packages nécessaires. Exécutez le workflow pour effectuer l'installation. Notez que vous devez exécuter ce workflow d'installation en tant qu'administrateur.
Vous pouvez également répéter la procédure ci-dessus et installer les packages via l'outil Python. Accédez à Installation de packages supplémentaires pour savoir comment installer des packages.
L'outil API Server possède 6 ancrages :
Ancrages d'entrée (les deux sont facultatifs) :
Ancrage d'entrée A (autorisation) : si vous choisissez d'utiliser les valeurs des champs de la configuration de l'outil, utilisez cet ancrage pour fournir vos informations d'autorisation. Sélectionnez le champ qui contient l'URL de base de votre API et un autre champ qui contient vos informations d'autorisation (généralement le champ Autorisation de la sortie A d'un outil API Server en amont). Notez que les informations d'autorisation sont une combinaison du préfixe Bearer et du jeton d'accès généré par oAuth2.0 lors de l'authentification initiale. Pour plus d'informations, consultez la page Configuration et autorisation de l'API Server.
Ancrage d'entrée D (données) : si vous choisissez d'utiliser les valeurs des champs de la configuration de l'outil, utilisez cet ancrage pour fournir les paramètres de votre point de terminaison. Notez que certains points de terminaison ont des paramètres requis.
Ancrages de sortie :
Ancrage de sortie A (authToken) : cet ancrage produit vos informations d'authentification afin qu'elles soient facilement disponibles si vous souhaitez effectuer plusieurs appels. Connectez cet ancrage de sortie à l'ancrage d'entrée A d'un autre outil API Server pour réauthentifier de manière transparente un autre appel d'API en aval.
Ancrage de sortie S (succès) : cet ancrage produit tous les appels d'API avec un code de réponse de 200. Les réponses d'API du niveau inférieur* sont analysées et les champs sont affichés ici. Si une réponse ne peut pas être analysée, le champ de sortie Extrait contient un message indiquant le motif, et les données brutes sont fournies dans les champs de sortie DownloadData et BinaryData.
Ancrage de sortie F (échec) : cet ancrage produit tous les appels d'API qui ne reçoivent pas le code de réponse 200.
Ancrage de sortie L (journaux) : cet ancrage produit les informations de journal qui résultent de votre appel d'API.
Cette réponse est simplifiée pour les besoins de cet exemple. L'exemple JSON brut affiche une réponse JSON type, suivie d'un exemple de la même réponse via l'outil API Server.
[
{
"id": "12345",
"dateCreated": "2023-05-02T16:50:05.829Z",
"runCount": 0,
"versions": [
{
"versionId": "67890",
"versionNumber": 1,
"dateCreated": "2023-05-02T16:50:05.829Z",
"details": {
"isAmp": false,
"fileName": "test.yxmd"
}
}
]
},
{
"id": "54321",
"dateCreated": "2023-05-03T10:50:48.681Z",
"runCount": 0,
"versions": [
{
"versionId": "09876",
"versionNumber": 1,
"dateCreated": "2023-05-03T10:50:48.681Z",
"details": {
"isAmp": false,
"fileName": "test2.yxmd"
}
}
]
}
]
La même réponse est formatée comme suit via l'outil API Server. Notez que l'élément versions est regroupé dans une colonne/un champ dans la réponse de l'outil API Server.
id | dateCreated | runCount | versions |
|---|---|---|---|
12345 | 2023-05-02T16:50:05.829Z | 0 | [{'versionId': '67890', 'versionNumber': 1, 'dateCreated': '2023-05-02T16:50:05.829Z', 'details': {'isAmp': False, 'fileName': 'test.yxmd'}}] |
54321 | 2023-05-03T10:50:48.681Z | 0 | [{'versionId': '09876', 'versionNumber': 1, 'dateCreated': '2023-05-03T10:50:48.681Z', 'details': {'isAmp': False, 'fileName': 'test2.yxmd'}}] |
Utilisez la fenêtre de configuration de l'outil pour configurer les champs nécessaires à l'exécution de votre appel d'API.
Utilisez la section Authentification pour fournir les informations d'authentification requises. Pour plus de détails, consultez les pages Clés et accès API et Configuration et autorisation de l'API Server.
Utiliser les valeurs des champs : désactivé par défaut. Activez cette option pour spécifier un champ entrant contenant votre URL de base et le jeton d'autorisation (clé d'accès d'API et secret d'accès d'API). Sélectionnez les champs via les listes déroulantes Sélectionner le champ URL de base et Sélectionner le champ Autorisation. Si vous utilisez cette option, seul le premier enregistrement que vous fournissez comme URL de base et jeton d'authentification est utilisé.
Vous pouvez également fournir vos informations d'authentification directement via la fenêtre de configuration de l'outil. Notez que ces champs sont masqués si vous activez l'option Utiliser les valeurs des champs ci-dessus.
URL de base : indiquez l'URL de base de l'outil API Server. Vous pouvez la configurer via Configuration de l'interface utilisateur Server.
Clé d'API : saisissez votre clé d'API.
Secret d'API : saisissez votre secret d'API.
Utilisez la section Configuration de l'API pour sélectionner votre méthode, choisir un point de terminaison et fournir des paramètres pour votre appel d'API.
Choisir la méthode : utilisez cette liste déroulante pour sélectionner votre méthode d'API. Choisissez parmi...
GET : la méthode GET vous permet de lire ou d'afficher une ressource. Par exemple, la méthode GET sur un point de terminaison users vous permet de lire ou d'afficher une liste d'utilisateurs.
POST : la méthode POST vous permet de créer une ressource. Par exemple, la méthode POST sur un point de terminaison users vous permet de créer un nouvel utilisateur.
PUT : la méthode PUT vous permet de mettre à jour une ressource. Plus précisément, la méthode PUT remplace la ressource existante. Par exemple, la méthode PUT sur un point de terminaison users vous permet d'effectuer une mise à jour en remplaçant les détails d'utilisateur existants par les informations que vous fournissez.
DELETE : la méthode DELETE vous permet de supprimer une ressource. Par exemple, la méthode DELETE sur un point de terminaison users vous permet de supprimer un utilisateur existant. Lorsque vous sélectionnez la méthode DELETE, le commutateur Confirmer la méthode DELETE apparaît. Vous devez activer ce commutateur pour exécuter une suppression avec succès.
Point de terminaison : utilisez cette liste déroulante pour sélectionner votre point de terminaison. Les options varient en fonction de la méthode sélectionnée. Pour en savoir plus sur les points de terminaison et les paramètres de l'API Server, consultez les pages Points de terminaison et paramètres d'API, Accéder à l'API Server V3 et Objets de l'API Server V3.
Utiliser les champs entrants pour les paramètres* : désactivé par défaut. Activez cette option pour spécifier les champs entrants à utiliser comme paramètres. Ensuite, utilisez les listes déroulantes disponibles pour spécifier le champ qui contient les informations sur les paramètres.
Entrer des valeurs de paramètres* : si vous choisissez de ne pas utiliser les champs entrants pour vos paramètres, vous pouvez entrer des paramètres directement via les champs fournis.
Paramètres des points de terminaison
Notez que les paramètres disponibles dépendent du point de terminaison. De plus, certains points de terminaison ont des paramètres requis, tandis que d'autres non. Pour en savoir plus sur les points de terminaison et les paramètres de l'API Server, consultez les pages Points de terminaison et paramètres d'API, Accéder à l'API Server V3 et Objets de l'API Server V3.
Charge utile : si vous choisissez d'indiquer la charge utile manuellement, vous pouvez la saisir ici directement au format JSON. Vous pouvez également utiliser l'option Utiliser les champs entrants pour les paramètres ci-dessus pour spécifier le champ entrant qui contient la charge utile.
Exemple de schéma : le cas échéant, l'exemple de schéma est rempli avec une structure correcte pour la charge utile de l'API. Vous pouvez sélectionner le bouton Utiliser le schéma dans la charge utile pour copier le texte générique dans l'onglet Charge utile et le modifier.