Passer au contenu principal
Ce guide vous expliquera, étape par étape, comment effectuer votre première requête. C’est une excellente ressource une fois que vous avez créé un compte X. Si vous souhaitez utiliser des extraits de code, des guides plus techniques, ou un outil graphique comme Postman, consultez les guides suivants pour effectuer votre première requête : Ce guide part du principe que vous avez récupéré votre API Key et Secret, votre user Access Token and Secret, votre App Access Token, et que vous les avez stockés en lieu sûr. Pour savoir comment procéder, suivez les étapes du guide Obtenir l’accès à la X API.

Étape 1. Identifier l’endpoint que vous souhaitez utiliser

La X API vous permet d’exécuter, via du code, une variété d’actions que vous pouvez également réaliser sur le site web ou l’application mobile de X. Nous proposons une liste complète des endpoints disponibles via l’API dans notre Index de référence de l’API, mais nous vous recommandons, pour plus de simplicité, de vous en tenir à l’un des suivants :

Étape 2. Choisir un outil pour formuler votre requête

Si certaines requêtes sont simples, d’autres peuvent être plus difficiles à concevoir. C’est pourquoi l’excellente communauté de développeurs a créé des outils qui masquent une partie de cette complexité. Voici quelques outils recommandés et des informations sur leur utilisation :

Postman

Postman est un outil visuel que vous pouvez utiliser pour envoyer des requêtes à des endpoints REST. Nous avons créé d’excellentes ressources sur Postman pour vous aider à démarrer et à explorer les différents endpoints disponibles via l’X API. Nous vous recommandons de lire notre tutoriel “Bien démarrer avec Postman” pour apprendre à ajouter vos clés et jetons et à effectuer votre première requête. Nous avons également produit un guide de démarrage rapide pour chacun de nos endpoints X API v2, dont la plupart utilisent Postman. Vous trouverez ces guides dans chaque section d’endpoint, mais voici des liens vers quelques-uns :
  • Quick start: Post a Tweet
  • Quick start: Search for Posts
  • Quick start: Lookup a user
Veuillez noter que vous ne pouvez pas envoyer de requêtes vers des endpoints de streaming avec Postman. Veuillez consulter le guide de démarrage rapide du flux filtré ou du flux échantillonné à 1 % pour apprendre à travailler avec ces endpoints. Si vous préférez un outil graphique plus simple, vous pouvez également envisager d’utiliser Insomnia.

Exemples de code

Si vous souhaitez utiliser un peu de code pour effectuer votre requête, nous avons rassemblé des exemples dans plusieurs langages pour chacun de nos endpoints de la X API v2. Vous pouvez trouver ces exemples via notre dépôt GitHub, X-API-v2-sample-code, qui contient également un fichier README expliquant comment configurer vos identifiants pour que les requêtes fonctionnent correctement. Par exemple, voici un exemple cURL pour l’endpoint de recherche d’utilisateur. Pour utiliser cette requête, remplacez simplement ACCESS_TOKEN et USERNAME par votre App Access Token et votre handle X. Ensuite, copiez-collez ce code dans votre outil en ligne de commande et appuyez sur « Return » ou « Enter ».
curl "https://api.x.com/2/users/by/username/$USERNAME" -H "Authorization: Bearer $ACCESS_TOKEN"

Bibliothèques

L’extraordinaire communauté des développeurs de X a également publié des bibliothèques dans divers langages de programmation, qui peuvent être utilisées pour envoyer des requêtes à la X API. Nous avons mis en place une page “Outils et bibliothèques” qui recense toutes les bibliothèques communautaires dont nous avons connaissance. Chaque bibliothèque devrait inclure un fichier README expliquant comment configurer le dépôt sur votre machine et effectuer votre première requête.
Veuillez noter : Si vous rencontrez des problèmes, consultez la documentation développeur concernant l’endpoint auquel vous envoyez une requête, notre section d’assistance, ou sollicitez l’aide de la communauté sur nos forums. Nous vous aiderons à mener votre requête à bien !

Étape 3. Examiner la réponse

Une fois votre requête effectuée avec succès, vous recevrez un payload contenant des metadata relatives à la requête. Si vous avez utilisé un endpoint qui emploie la méthode HTTP GET, vous recevrez des metadata relatives à la ressource (Post, utilisateur, List, Space, etc.) visée par la requête, au format JSON. Passez en revue les différents fields renvoyés et vérifiez si vous pouvez faire correspondre les informations demandées au contenu sur X. Si vous avez utilisé un endpoint qui emploie les méthodes HTTP POST, PUT ou DELETE, vous avez réalisé une action sur X. Rendez-vous sur X.com ou dans l’App mobile et vérifiez si vous pouvez retrouver cette action.

Étape 4. Ajustez votre requête à l’aide de paramètres

Chaque endpoint propose un ensemble de paramètres différent que vous pouvez utiliser pour modifier votre requête. Par exemple, vous pouvez demander des champs de metadata supplémentaires lorsque vous utilisez des endpoints GET avec les paramètres fields et expansions. Vous pouvez également tester une variété d’outils de filtrage avec des endpoints tels que recherche de Posts, comptage de Posts et flux filtré afin de restreindre les data que vous recevez aux seuls Posts qui vous intéressent. Vous trouverez la liste complète des paramètres de requête et des fields dans la référence de l’API pour l’endpoint sur lequel vous travaillez, ainsi qu’une multitude d’autres informations utiles à l’intégration dans nos guides d’intégration et nos pages de notions fondamentales. Vous pouvez en savoir plus sur l’ensemble des supports pédagogiques que nous mettons à votre disposition dans notre guide Ressources importantes.
I