Passer au contenu principal
Cette page présente plusieurs outils et concepts clés à connaître lors de l’intégration des endpoints de mise en sourdine à votre système. Nous avons divisé 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 disponible. Pour en savoir plus sur nos collections Postman, consultez notre page “Utiliser Postman”. 

​
Exemples de code

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

​
Bibliothèques tierces

Tirez parti de l’une des bibliothèques tierces de 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 clés

​
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 soit le Contexte utilisateur OAuth 1.0a, soit OAuth 2.0 Autorisation par code avec PKCE pour authentifier vos requêtes vers ces endpoints. Contexte utilisateur OAuth 1.0a vous impose d’utiliser vos API Keys, des Access Tokens utilisateur et quelques autres paramètres pour créer un en-tête d’autorisation, que vous joindrez ensuite à votre requête. 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 qu’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 bibliothèque, un outil comme Postman, ou OAuth 2.0 pour authentifier vos requêtes. OAuth 2.0 Autorisation par code avec PKCE permet un meilleur contrôle de la portée d’une application et des flux d’autorisation sur plusieurs appareils. OAuth 2.0 vous permet de choisir des portées fines et granulaires qui vous confèrent 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, disponibles dans la section App settings du developer portal.

​
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 créer un compte développeur, configurer un Project dans ce compte, puis créer une App développeur dans ce Project. Vous pourrez ensuite retrouver vos clés et jetons dans votre App développeur.  

​
Limites de taux

Chaque jour, plusieurs milliers de développeurs envoient des requêtes vers la X API. Pour gérer l’important volume de ces requêtes, des limites de taux sont appliquées à chaque endpoint, ce qui limite le nombre de requêtes que vous pouvez effectuer pour le compte de votre App ou d’un utilisateur authentifié.  Ces endpoints sont limités au niveau utilisateur, ce qui signifie que l’utilisateur authentifié pour le compte duquel vous effectuez la requête ne peut appeler l’endpoint qu’un certain nombre de fois, et ce, sur n’importe quelle App développeur. La limite de taux utilisateur est de 50 requêtes par 15 minutes et par endpoint pour les méthodes POST et DELETE. En revanche, pour la méthode GET, la limite de taux est de 15 requêtes par 15 minutes.  

​
fields et expansions

L’endpoint GET de X API v2 permet aux utilisateurs de sélectionner précisément les données qu’ils souhaitent obtenir 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 le payload. Par exemple, cet endpoint vous permet de récupérer les expansions suivantes :
  • pinned_tweet_id
Le paramètre fields vous permet de sélectionner exactement quels fields au sein des différents objets de données vous souhaitez recevoir. Cet endpoint renvoie principalement des objets utilisateur. Par défaut, l’objet utilisateur retourne les champs id, name et username. Pour recevoir des champs supplémentaires tels que user.created_at ou user.entities, vous devrez les demander explicitement en utilisant un paramètre fields. Nous avons ajouté à notre X API v2 data dictionary un guide sur l’utilisation conjointe des fields et expansions. La recherche des utilisateurs mis en sourdine peut renvoyer un volume important 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 renvoient plus de résultats que ce qu’une seule réponse peut contenir. Dans ce cas, les data sont renvoyées sous la forme d’une série de « pages ». En savoir plus sur la manière de paginer les résultats.
Veuillez noter : Si un utilisateur met en sourdine depuis X, une limite de 200 requêtes par tranche de 15 minutes s’applique.
⌘I