Passer au contenu principal
Cette page présente plusieurs outils et concepts essentiels à connaître lorsque vous intégrez l’endpoint de recherche des Posts d’une List à votre système. Nous avons découpé la page en plusieurs sections :

Outils utiles

Avant d’aborder certains concepts clés qui vous aideront à intégrer cet endpoint, nous vous recommandons de vous familiariser avec :

Postman

Postman est un excellent outil pour tester un endpoint. Chaque requête Postman inclut tous les paramètres de chemin et de corps afin de vous aider à comprendre rapidement ce qui est à votre disposition. Pour en savoir plus sur nos collections Postman, consultez notre page “Utiliser Postman”

Exemples de code

Vous souhaitez utiliser cet endpoint avec du code dans votre langage de programmation préféré ? Nous proposons plusieurs exemples de code à utiliser comme point de départ sur notre page GitHub.

Bibliothèques tierces

Profitez de l’une des bibliothèques tierces développées par notre communauté pour vous aider à démarrer. Vous pouvez trouver une bibliothèque compatible avec les endpoints v2 en recherchant l’étiquette de version appropriée.

Concepts principaux

Authentification

Tous les endpoints X API v2 exigent d’authentifier vos requêtes à l’aide d’un ensemble d’identifiants, également appelés clés et jetons. Vous pouvez utiliser Contexte utilisateur OAuth 1.0a, App only ou OAuth 2.0 Autorisation par code avec PKCE pour authentifier vos requêtes vers cet endpoint. Contexte utilisateur OAuth 1.0a, ce qui signifie que vous devez utiliser un ensemble d’API Keys et de user Access Tokens pour effectuer une requête avec succès. Les access tokens doivent être associés à l’utilisateur pour le compte duquel vous effectuez la requête. Si vous souhaitez générer un ensemble d’Access Tokens pour un autre utilisateur, celui-ci doit autoriser votre App en utilisant le flux OAuth à 3 étapes. Veuillez noter que OAuth 1.0a peut être difficile à utiliser. Si vous n’êtes pas familier avec cette méthode d’authentification, nous vous recommandons d’utiliser une library, un outil comme Postman, ou d’utiliser OAuth 2.0 ou App only pour authentifier vos requêtes. OAuth 2.0 Autorisation par code avec PKCE permet un meilleur contrôle du périmètre d’une application et des flux d’autorisation sur plusieurs appareils. OAuth 2.0 vous permet de choisir des scopes précis et granulaires qui vous accordent des autorisations spécifiques au nom d’un utilisateur. Pour activer OAuth 2.0 dans votre App, vous devez l’activer dans les paramètres d’authentification de votre App, situés dans la section App settings du developer portal. App only nécessite simplement de transmettre un App only Access Token avec votre requête. Vous pouvez soit générer un App only Access Token directement au sein d’une App développeur, soit en générer un en utilisant l’endpoint POST oauth2/token.

developer portal, Projects et Apps développeur

Pour obtenir un ensemble d’identifiants d’authentification compatibles avec les endpoints de la X API v2, vous devez vous inscrire pour obtenir un compte développeur, créer un Project dans ce compte, puis créer une App développeur dans ce Project. Vous pourrez ensuite trouver vos clés et jetons dans votre App développeur.  

Limites de taux

Chaque jour, des dizaines de milliers de développeurs envoient des requêtes vers la X API. Pour aider à gérer le volume de ces requêtes, des limites de taux sont appliquées à chaque endpoint afin de limiter le nombre de requêtes que vous pouvez effectuer pour le compte de votre App ou d’un utilisateur authentifié. Cet endpoint est soumis à des limites de taux à la fois au niveau de l’App et au niveau de l’utilisateur. La limite de taux au niveau de l’App signifie que vous, en tant que développeur, ne pouvez effectuer qu’un certain nombre de requêtes vers cet endpoint sur une période donnée depuis n’importe quelle App (en utilisant soit l’API Key et la Clé secrète de l’API, soit le Jeton Bearer). La limite de taux au niveau de l’utilisateur signifie que l’utilisateur authentifié pour le compte duquel vous effectuez la requête ne peut effectuer une recherche de Posts de List qu’un certain nombre de fois, et ce, sur n’importe quelle App développeur. Le tableau ci-dessous présente les limites de taux pour chaque endpoint.
EndpointMéthode HTTPLimite de taux
/2/lists/:id/tweetsGET900 requêtes par 15 minutes
Champs et expansions L’endpoint GET de la X API v2 permet aux utilisateurs de sélectionner exactement quelles données ils souhaitent récupérer depuis l’API à l’aide d’un ensemble d’outils appelés fields et expansions. Le paramètre expansions vous permet d’inclure les objets référencés dans la charge utile. Par exemple, la recherche de Posts de List vous permet de récupérer les expansions suivantes :
  • author_id
Le paramètre fields vous permet de sélectionner précisément quels fields au sein des différents objets de données vous souhaitez recevoir. Cet endpoint fournit principalement des Objets Post. Par défaut, l’Objet Post renvoie les champs id et text. Pour recevoir des champs supplémentaires tels que tweet.created_at ou tweet.lang, vous devrez les demander explicitement à l’aide d’un paramètre fields. Nous avons ajouté à notre X API v2 data dictionary un guide sur l’utilisation conjointe des fields et expansions. Le tableau ci-dessous présente les fields et expansions disponibles pour l’endpoint de recherche :
EndpointFieldsExpansions
/2/lists/:id/tweetstweet.fields

user.fields
author_id
Pagination La recherche de Posts de List peut retourner un grand volume de données. Pour garantir des résultats cohérents et performants à tout moment, nous utilisons la pagination. La pagination est une fonctionnalité des endpoints de la X API v2 qui retournent plus de résultats que ce qui peut être inclus dans une seule réponse. Lorsque cela se produit, les données sont renvoyées sous forme de « pages ». En savoir plus sur la manière de paginer les résultats.
I