Bien démarrer avec Postman

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

​

Introduction

Postman est une application de bureau et une application Web qui vous permet d’effectuer des requêtes vers une API à partir d’une interface graphique. Nous recommandons d’utiliser Postman avec X API, X Ads API et les endpoints Labs lorsque vous explorez les fonctionnalités des API, ainsi que lorsque vous rencontrez des problèmes avec votre application. 

Nous proposons actuellement deux collections Postman :

Collection X API v2

Collection X Ads API

​

Prérequis

Avant de commencer à utiliser les collections Postman de X, vous devez vous assurer de disposer des droits d’accès et des identifiants appropriés pour l’outil de la plateforme développeur X que vous souhaitez utiliser. Vous pouvez en savoir plus sur l’obtention de ces accès sur notre page « Premiers pas ». 

Une fois que vous possédez un compte développeur, que vous avez configuré une App développeur, que vous disposez d’un ensemble de clés et de jetons d’authentification et que vous avez correctement configuré 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.  

​

Premiers pas avec les collections Postman de X

​

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

Même si vous pourriez définir vous‑même les endpoints spécifiques que vous souhaitez utiliser dans Postman, nous avons déjà fait tout le travail pour vous et créé une collection prête à l’emploi regroupant les API pertinentes. Cliquez simplement sur l’un des liens de la section « Postman collections » précédente et une collection contenant tous les endpoints associés à l’API sélectionnée sera ajoutée à votre application Postman. Ces collections sont également disponibles dans le réseau d’API Postman. Chaque endpoint inclut automatiquement les paramètres disponibles, des exemples de réponses et le type d’authentification préconfiguré, de sorte que vous n’avez plus qu’à ajouter vos identifiants et les valeurs de vos paramètres pour commencer à explorer les fonctionnalités.

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

​

Étape deux : ajouter vos clés et jetons en tant que variables d’environnement

Lorsque vous ajoutez la collection à votre instance Postman, elle ajoute automatiquement un environnement appelé « X API v2 », auquel vous devrez ajouter vos clés et jetons. Dans cette étape, nous allons vous guider tout au long du 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 » dans le coin supérieur droit de Postman : il s’agit du bouton des paramètres situé 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 différents jetons que vous avez générés via le tableau de bord Apps dans le tableau. Voici un exemple de ce à quoi votre tableau devrait ressembler :

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 les 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 identifiants en tant que variables et que vous vous êtes assuré que l’environnement X API v2 est sélectionné, vous serez prêt à envoyer des requêtes vers la collection X API v2. En effet, les onglets d’autorisation de chaque endpoint sont configurés pour hériter automatiquement des variables depuis cet environnement. 

Pour utiliser Postman avec des User Access Tokens, reportez-vous à XXXX pour consulter des détails supplémentaires sur la procédure à suivre.

​

Étape 3 : sélectionner un endpoint

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

Dans 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 à vous rendre dans l’onglet Params. Vous devriez voir un ensemble de paramètres inactifs avec des descriptions expliquant ce que fait chaque paramètre, ainsi qu’une liste de toutes les valeurs possibles que vous pouvez transmettre avec 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 « Path Variable » obligatoire, id. Comme cet endpoint renvoie des Publications, nous devons ajouter un identifiant de Publication valide comme valeur.

Vous pouvez trouver l’id de la Publication en vous rendant sur x.com, en cliquant sur une Publication, puis en regardant l’URL. Par exemple, l’id de Publication de l’URL suivante est 1228393702244134912 :

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

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

Si vous avez correctement saisi tout ce qui est indiqué dans cette étape, l’onglet Params devrait ressembler à ce qui suit :

​

Étape cinq : Envoyer votre requête et examiner votre réponse

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

Si tout a été correctement configuré, vous devriez recevoir le payload suivant :

{
    "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": "Developers",
                "id": "2244994945"
            }
        ]
    }
}

​

Générer un jeton d’accès utilisateur avec Postman :

​

Utiliser OAuth 1.0a pour générer un jeton d’accès utilisateur

Examinez le processus en trois étapes utilisé dans la collection de test du flux OAuth 1.0a.

​

Utiliser OAuth 2.0 pour générer un jeton d’accès utilisateur

Si vous souhaitez générer un jeton d’accès utilisateur OAuth 2.0 dans Postman, vous pouvez générer des jetons d’accès OAuth 2.0 à utiliser avec la collection Postman X API v2.

Dans votre espace de travail, cliquez sur la collection, accédez à l’onglet intitulé « Auth » et sélectionnez le type « OAuth 2.0 ». À partir de là, sous le titre « Configure New Token », allez à l’endroit où il est indiqué « Configuration Options ». Vous pouvez définir le « Grant Type » sur « Authorization Code (With PKCE) ».

Vous devrez mettre à jour votre URL de rappel pour qu’elle corresponde à l’URL de rappel associée à votre application. De plus, vous devrez mettre à 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 OAuth 2.0 client ID 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 URL de rappel (également appelée URL de redirection). Elle doit correspondre à ce que vous avez dans les paramètres d’authentification de votre App.
• State - state

Lorsque vous êtes prêt, vous pouvez cliquer sur « Get New Access Token » pour générer un jeton d’accès. Si une boîte de dialogue indique que quelque chose s’est mal passé, vous devrez peut‑être appuyer sur le bouton Retour pour vous connecter. Vous devrez autoriser votre app à accéder à votre compte en cliquant sur « Authorize app » dans la boîte de dialogue.

Après avoir autorisé votre app, vous serez redirigé vers Postman, où vous pourrez voir votre jeton et cliquer sur 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 de Postman intitulé « Code », vous pouvez convertir la requête que nous venons de créer dans le langage de programmation de votre choix, comme Python, Node.js ou Ruby, pour vous aider à démarrer. Postman dispose d’une excellente documentation qui peut vous être utile. Nous proposons également du code d’exemple sur GitHub qui peut vous aider à vous intégrer plus rapidement aux endpoints de l’API.