Prise en main de Postman

Dans ce tutoriel, nous expliquerons ce qu’est Postman et comment le configurer rapidement.

​

Introduction

Postman est une application de bureau et web qui permet d’effectuer des requêtes vers une API depuis une interface graphique. Nous recommandons d’utiliser Postman avec la X API, la X Ads API et les endpoints Labs pour explorer les fonctionnalités des API, ainsi que pour diagnostiquer les problèmes de votre application.

Nous proposons actuellement deux collections Postman :

X API v2 Collection

X Ads API Collection

​

Prérequis

Avant de commencer à utiliser les collections Postman de X, assurez‑vous de disposer des droits d’accès et des identifiants appropriés pour l’outil de la plateforme développeur X de votre choix. Pour en savoir plus sur l’obtention de l’accès, consultez notre page « Getting started ».

Une fois que vous disposez d’un compte développeur, que vous avez configuré une App développeur, obtenu un ensemble de clés et jetons d’authentification et correctement préparé votre environnement pour effectuer des requêtes vers l’API spécifique que vous prévoyez d’utiliser, vous pouvez suivre les étapes ci‑dessous pour commencer.  

​

Bien démarrer avec les collections Postman de X

​

Première étape : ajoutez l’une des collections Postman de X à votre compte

Bien que vous puissiez configurer vous‑même les endpoints que vous souhaitez utiliser dans Postman, nous avons fait le plus gros du travail pour vous en préparant une collection prête à l’emploi d’API pertinentes. Cliquez simplement sur l’un des liens de la section précédente « Postman collections » : une collection contenant tous les endpoints associés à l’API sélectionnée sera ajoutée à votre App Postman. Ces collections sont également disponibles dans le Postman API network. Chaque endpoint inclura automatiquement les paramètres disponibles, des exemples de réponses et le type d’authentification déjà renseigné ; il vous suffira d’ajouter vos identifiants et les valeurs de paramètres pour commencer à explorer les fonctionnalités.

Dans cet exemple, nous allons utiliser la collection API v2 de X.   

​

Deuxième étape : ajoutez vos clés et jetons en tant que variables d’environnement

Lorsque vous ajoutez la collection à votre instance Postman, un environnement nommé « X API v2 » est automatiquement créé, et vous devrez y ajouter vos clés et jetons. Dans cette étape, nous vous guidons dans le processus d’ajout de vos clés et jetons depuis votre App développeur dans l’environnement « X API v2 ». 

Pour ajouter vos clés et jetons à l’environnement « X API v2 », cliquez sur le bouton « Manage Environments » en haut à droite de Postman. Vous pouvez également cliquer sur le bouton des paramètres dans le coin supérieur droit.   

Dans la liste des environnements, cliquez sur « X API v2 ». 

Ensuite, ajoutez une variable pour chacune des différentes clés et chacun des jetons que vous avez générés via le tableau de bord Apps, dans le tableau. Voici un exemple de l’apparence attendue de votre tableau :

VARIABLE	VALEUR INITIALE	VALEUR ACTUELLE
consumer_key	QAktM6W6DF6F7XXXXXX	QAktM6W6DF6F7XXXXXX
consumer_secret	AJX560A2Omgwyjr6Mml2esedujnZLHXXXXXX	AJX560A2Omgwyjr6Mml2esedujnZLHXXXXXX
access_token	1995XXXXX-0NGqVhk3s96IX6SgT3H2bbjOPjcyQXXXXXXX	1995XXXXX-0NGqVhk3s96IX6SgT3H2bbjOPjcyQXXXXXXX
token_secret	rHVuh7dgDuJCOGeoe4tndtjKwWiDjBZHLaZXXXXXX	rHVuh7dgDuJCOGeoe4tndtjKwWiDjBZHLaZXXXXXX
bearer_token	AAAAAAAAAAAAAAAAAAAAAL9v6AAAAAAA99t03huuqRYg0mpYAAFRbPR3XXXXXXX	AAAAAAAAAAAAAAAAAAAAAL9v6AAAAAAA99t03huuqRYg0mpYAAFRbPR3XXXXXXX

Notez que les clés et jetons utilisés dans le tableau ci-dessus sont fictifs et ne fonctionneront pas s’ils sont utilisés dans une requête. 

Une fois que vous avez ajouté vos informations d’identification en tant que variables et vérifié que l’environnement « X API v2 » est sélectionné, vous êtes prêt à effectuer des requêtes vers la collection X API v2. En effet, chaque onglet d’autorisation des endpoints est configuré pour hériter automatiquement des variables de cet environnement. 

Pour utiliser Postman avec des Access Tokens utilisateur, passez à XXXX pour consulter des informations supplémentaires sur la procédure.

​

Troisième étape : sélectionner un endpoint

L’étape suivante consiste à choisir un endpoint dans la collection et à commencer à construire votre requête. Vous pouvez sélectionner un endpoint depuis la navigation située à droite. Voici à quoi cela ressemble :

Pour cet exemple, nous allons utiliser l’endpoint X API v2 > Post Lookup > Single Post. 

​

Quatrième étape : ajouter des valeurs dans l’onglet Params

L’étape suivante consiste à ouvrir l’onglet Params. Vous devriez voir un ensemble de paramètres inactifs avec des descriptions expliquant le rôle de chaque paramètre, ainsi qu’une liste de toutes les valeurs potentielles que vous pouvez transmettre dans votre requête.

Dans cet exemple, nous allons activer les paramètres de requête expansions et tweet.fields et ajouter les valeurs suivantes :

Key	Value
tweet.fields	created_at,attachments
expansions	author_id

En plus d’ajouter les paramètres de requête, nous devons ajouter la variable de chemin requise, id. Étant donné que cet endpoint renvoie des Posts, nous devons fournir un ID de Post valide comme valeur.

Vous pouvez trouver l’ID de Post en vous rendant sur x.com, en cliquant sur un Post, puis en consultant l’URL. Par exemple, l’ID de Post de l’URL suivante est 1228393702244134912 :

https://x.com/XDevelopers/status/1228393702244134912

Dans l’onglet Params, faites défiler la page au‑delà de tous les paramètres de requête pour afficher la section « Path Variables ». Nous allons ajouter l’ID de Post que vous souhaitez utiliser comme valeur pour la clé id.

Si vous avez correctement saisi tous les éléments de cette étape, l’onglet Params devrait ressembler à ce qui suit :

​

Cinquième étape : envoyez votre requête et vérifiez la réponse

Maintenant que tout est prêt dans votre requête, vous pouvez cliquer sur le bouton « Send ».

Si tout a été configuré correctement, vous devriez recevoir la charge utile suivante :

{
    "data": {
        "author_id": "2244994945",
        "text": "Qu'est-ce que le développeur a écrit dans sa carte de Saint-Valentin ?\n  \nwhile(true) {\n    I = Love(You);  \n}",
        "id": "1228393702244134912",
        "created_at": "2020-02-14T19:00:55.000Z"
    },
    "includes": {
        "users": [
            {
                "username": "XDevelopers",
                "name": "Développeurs",
                "id": "2244994945"
            }
        ]
    }
}

​

Générer un Access Token utilisateur avec Postman :

​

Utiliser OAuth 1.0a pour générer un Access Token utilisateur

Consultez le processus en trois étapes présenté dans la collection de test du flux OAuth 1.0a.

​

Utiliser OAuth 2.0 pour générer un access token utilisateur

Si vous souhaitez générer un access token utilisateur OAuth 2.0 dans Postman, vous pouvez générer des access tokens OAuth 2.0 à utiliser avec la collection Postman API v2 de X.

Cliquez sur la collection dans votre espace de travail, ouvrez l’onglet « Auth » et sélectionnez le type « OAuth 2.0 ». Ensuite, sous l’en-tête « Configure New Token », allez à « Configuration Options ». Vous pouvez définir « Grant Type » sur « Authorization Code (With PKCE) ».

Mettez à jour votre Callback URL pour qu’elle corresponde à l’URL de rappel associée à votre application. Mettez également à jour les paramètres suivants :

• Auth URL - https://x.com/i/oauth2/authorize
• Access Token URL - https://api.x.com/2/oauth2/token
• Client ID - Votre client ID OAuth 2.0 depuis le Dev Portal
• Client Secret - Si vous utilisez un client confidentiel
• Update Scope - Scopes correspondant aux endpoints auxquels vous souhaitez vous connecter. Exemple « tweet.read users.read »
• Votre Callback URL (également appelée redirect URL). Elle doit correspondre à ce que vous avez dans les paramètres d’authentification de votre App.
• State - state

Lorsque vous êtes prêt, cliquez sur « Get New Access Token » pour générer un Access Token. Si une boîte de dialogue indique qu’une erreur est survenue, vous devrez peut-être appuyer sur le bouton Précédent pour vous connecter. Vous devrez autoriser votre application à accéder à votre compte en cliquant sur « Authorize app » dans la boîte de dialogue.

Après avoir autorisé votre application, vous serez redirigé vers Postman, où vous pourrez voir votre token et sélectionner le bouton « Use Token » pour commencer à effectuer des requêtes au nom d’un utilisateur autorisé.

Vous êtes maintenant prêt à utiliser la collection Postman.

​

Et ensuite

Si vous cliquez sur le bouton « Code » dans Postman, vous pouvez convertir la requête que nous venons de créer dans le langage de votre choix, comme Python, Node ou Ruby, pour vous aider à démarrer. Postman propose une excellente documentation qui peut vous être utile. Nous avons également des exemples de code sur GitHub qui peuvent vous aider à vous intégrer plus rapidement aux endpoints.