Pitchfork - l'application Web de l'API Rackspace Cloud

Si vous voulez un moyen interactif de référencer la documentation et d'exécuter des commandes API pour les produits Rackspace Cloud, vous devez interagir rapidement avec un produit, ou vous voulez profiter de nouveaux produits ou fonctionnalités qui ne sont pas disponibles dans le panneau de configuration, Pitchfork pourrait être l'outil pour vous.

Pitchfork est une application API Web interactive qui permet à un utilisateur d'interagir rapidement avec les produits Rackspace Cloud. Il n'est pas nécessaire d'afficher une invite de commande ou de rechercher comment envoyer des objets de données à l'aide d'une commande cURL. L'application gère tout cela pour vous et affiche les résultats et les réponses des requêtes API du produit que vous avez effectuées sur votre compte Cloud.

Pitchfork a été conçu pour effectuer les appels API et pour vous montrer ce dont vous avez besoin pour les appels API afin que vous puissiez les exécuter en utilisant d'autres outils ou méthodes. Vous pouvez utiliser la fonction de simulation pour vérifier la structure des données d'un appel, qui peut servir d'outil de référence dans vos programmes d'API Rackspace.

Les API peuvent être déroutantes pour les débutants. Parce que Pitchfork établit la structure d'appel pour vous, vous pouvez apprendre beaucoup plus rapidement. Parfois, l'API est le seul moyen de modifier la configuration d'un équilibreur de charge ou d'une base de données cloud, par exemple, et Pitchfork peut à la fois vous montrer comment passer l'appel et l'exécuter pour vous.

Où trouver Pitchfork

Vous pouvez accéder à Pitchfork à l'adresse suivante :https://pitchfork.rax.io

Regardez le code dans GitHub.

Vous n'avez pas besoin de vous connecter à l'application pour simuler ou parcourir l'un des appels API. Vous devez vous connecter uniquement si vous souhaitez exécuter ces appels sur votre compte.

Pour vous connecter, cliquez sur Connexion et entrez vos identifiants d'authentification.

Authentification

Pitchfork utilise les mêmes informations d'identification que vous utilisez dans une demande d'authentification API à Rackspace Cloud. Vous fournissez votre nom d'utilisateur et votre clé API, et le système effectue la demande d'authentification pour vous via HTTPS. Si la demande aboutit, l'application stocke le jeton et le catalogue de services renvoyés et fait expirer la session avec le jeton au moment opportun.

Utiliser Pitchfork pour envoyer un appel API

Après vous être connecté, procédez comme suit pour envoyer un appel d'API à l'aide de Pitchfork :

Naviguez jusqu'à l'un des produits et trouvez l'appel que vous souhaitez exécuter.
Choisissez la région avec laquelle vous souhaitez interagir.
Cliquez sur Détails .
S'il existe des variables pour l'appel, saisissez-les.
Cliquez sur Envoyer un appel API .

L'application vous montre les informations suivantes :

URL de la demande : L'URL entièrement construite à laquelle vous avez envoyé l'appel.
En-têtes de demande : La partie des en-têtes de la requête que vous avez envoyée à l'API.
Demander un objet de données : Si un objet de données a été créé pour l'appel, il s'affiche avec les valeurs que vous avez spécifiées.
En-têtes de réponse : Les en-têtes reçus dans la réponse de l'API.
Corps de la réponse : Les données de réponse du serveur d'API. Cette réponse peut inclure un code d'état, un objet renvoyé ou un message d'erreur.
Remarque : Les en-têtes de réponse et le corps de la réponse sont affichés uniquement pour les appels exécutés et non pour les appels simulés. Parce que les simulations ne sont pas exécutées, il n'y a aucune réponse à montrer.

simulation

L'option mock vous permet de créer un appel sans l'exécuter afin que vous puissiez voir comment l'appel est structuré. Cliquez sur Mock API Call lorsque vous souhaitez voir tous les détails de la demande d'un appel. L'objet de données de demande, s'il y en a un, est affiché avec toutes les options disponibles pour l'appel et, pour référence, vous pouvez voir comment l'objet est structuré.

Mises en garde pour l'exécution des appels

Lorsque vous êtes connecté, les appels s'exécutent sur votre compte Cloud. Il y a des notes sur les appels pour vous avertir lorsque vous faites quelque chose qui affectera la facturation, alors soyez attentif lors de l'exécution des appels.

Lorsque vous vous moquez d'un appel, aucun appel d'API n'est exécuté, il n'y a donc aucun impact sur votre compte.

Historique des appels

Vous pouvez facilement voir l'historique des appels que vous avez passés en cliquant sur Historique dans le menu. L'historique affiche les appels que vous avez passés avec tous les détails. L'historique est enregistré pour les appels que vous avez exécutés sur l'API, quelle que soit la réponse. Les appels API factices ne sont pas enregistrés dans votre historique. Vous devez être connecté pour voir votre historique.

L'historique des appels est enregistré pour vous permettre de vérifier ou de référencer les appels passés effectués dans le système. Ceci est utile lorsque plusieurs utilisateurs utilisent le même ensemble d'informations d'identification. L'historique des appels comprend les éléments suivants :

Terminé : L'horodatage de l'appel (fuseau horaire UTC).
Détails de l'appel : Détails sur l'appel, y compris la description, l'URL de la documentation et le titre.
Région : La région où vous avez exécuté l'appel, comme DFW ou ORD.
Demande : Les parties de la demande qui sont enregistrées pour référence incluent l'URL, le verbe et tout objet de données transmis à l'API.
Réponse : Le corps de la réponse, les en-têtes de réponse et le code de réponse.
Nom d'utilisateur : Le nom d'utilisateur de l'utilisateur qui exécute les appels contre l'API.
Numéro de compte : Le numéro de compte Cloud.

Appels fréquemment répétés

Si vous avez un appel que vous exécutez fréquemment, cliquez sur l'icône en forme d'étoile à côté de l'appel. Cela l'ajoute à vos favoris et vous pouvez accéder à ces appels depuis la page d'accueil ou depuis les favoris dans le menu. Vous ne pouvez ajouter ou afficher vos favoris que lorsque vous êtes connecté à l'application.