Passer au contenu principal

Bien démarrer avec l’endpoint de consultation des Posts d’une List

Ce guide de démarrage rapide vous aidera à effectuer votre première requête vers l’endpoint de consultation des Posts d’une List à l’aide de Postman. Veuillez consulter notre dépôt GitHub X API v2 sample code si vous souhaitez voir des exemples de code dans différentes langues.

Prérequis

Pour suivre ce guide, vous aurez besoin d’un ensemble de clés et jetons afin d’authentifier votre requête. Vous pouvez générer ces clés et jetons en suivant ces étapes :
  • Inscrivez-vous pour obtenir un compte développeur et attendez l’approbation.
  • Créez un Project et une App développeur associée dans le developer portal.
  • Accédez à la page « Keys and tokens » de votre App pour générer les informations d’identification requises. Assurez-vous d’enregistrer toutes les informations d’identification dans un emplacement sécurisé.

Étapes pour créer une requête de recherche de Posts d’une List

Première étape : commencer avec un outil ou une bibliothèque

Il existe plusieurs outils, exemples de code et bibliothèques que vous pouvez utiliser pour envoyer une requête à cet endpoint, mais nous utiliserons ici l’outil Postman pour simplifier le processus. Pour charger la collection X API v2 dans votre environnement Postman, veuillez cliquer sur le bouton suivant : Une fois la collection X API v2 chargée dans Postman, accédez au dossier « List », sélectionnez le dossier « List Posts », puis choisissez « List Posts lookup ».  

Deuxième étape : authentifiez votre requête

Pour effectuer correctement une requête vers la X API, vous devez vérifier que vous disposez des autorisations nécessaires. Pour ce faire avec cet endpoint, vous devez authentifier votre requête à l’aide des méthodes d’authentification App onlyOAuth 2.0 Authorization Code with PKCE ou OAuth 1.0a User Context. Pour simplifier, nous allons utiliser App only pour cette requête, mais si vous souhaitez demander des métriques privées ou des Posts, vous devrez utiliser l’une des autres méthodes d’authentification. Pour utiliser App only, vous devez ajouter vos clés et jetons (en particulier le App only Access Token, également appelé App only Bearer Token) dans Postman en sélectionnant l’environnement nommé « X API v2 » (dans le coin supérieur droit de Postman), puis en ajoutant vos clés et jetons dans les champs « initial value » et « current value » (en cliquant sur l’icône en forme d’œil à côté du menu déroulant des environnements). Si vous avez effectué cette opération correctement, ces variables seront automatiquement renseignées dans l’onglet d’autorisation de la requête.  

Étape trois : identifier et spécifier la List dont vous souhaitez récupérer des Posts

Vous devez indiquer, dans la requête, la List dont vous souhaitez recevoir les données. Vous pouvez trouver l’id de la List en vous rendant sur x.com, en cliquant sur une List, puis en regardant l’URL. Par exemple, l’id de la List dans l’URL suivante est 84839422. https://x.com/i/lists/84839422 L’id cible peut être n’importe quel id de List valide. Dans Postman, accédez à l’onglet “Params”, puis saisissez votre id dans la colonne “Value” de la variable de chemin id. Veillez à ne pas inclure d’espace avant ou après un id.
KeyValue
id84839422 (id de la List)

Étape quatre : identifier et préciser les fields que vous souhaitez récupérer

Si vous cliquez sur le bouton « Send » après l’étape trois, vous recevrez les fields par défaut de l’Objet Post dans votre réponse : id et text. Si vous souhaitez recevoir des fields supplémentaires, vous devrez spécifier ces fields dans votre requête avec les paramètres tweet.fields et/ou expansions. Pour cet exercice, nous allons demander trois ensembles supplémentaires de fields provenant d’objets différents :
  • Le field supplémentaire created_at dans l’objet principal Lists.
  • L’objet utilisateur complet en utilisant le paramètre expansion
  • Le field supplémentaire user.created_at dans l’objet utilisateur associé.
Dans Postman, accédez à l’onglet « Params » et ajoutez la paire clé:valeur suivante au tableau « Query Params » :
KeyValueReturned fields
tweet.fieldscreated_atcreated_at
expansionsauthor_idincludes.users.id,
includes.users.name,
includes.users.username
user.fieldscreated_atincludes.users.created_at
Vous devriez maintenant voir une URL similaire à côté du bouton « Send » : https://api.x.com/2/lists/84839422/tweets?expansions=author_id&user.fields=created_at&max_results=1

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

Une fois tout configuré, cliquez sur le bouton « Send », et vous recevrez une réponse similaire à l’exemple suivant :
{
  "data": [
    {
      "author_id": "4172587277",
      "id": "1458172421115101189",
      "text": "L'Allemagne a enregistré cette semaine un record de nouveaux cas de Covid-19. Selon le gouvernement et les experts en santé, les personnes non vaccinées sont responsables de la situation \nhttps://t.co/4POyaPwMLu"
    }
  ],
  "includes": {
    "users": [
      {
        "username": "MomentsBrasil",
        "name": "X Moments Brasil",
        "created_at": "2015-11-12T16:46:02.000Z",
        "id": "4172587277"
      }
    ]
  },
  "meta": {
    "result_count": 1,
    "next_token": "7140dibdnow9c7btw3z2vwioavpvutgzrzm9icis4ndix"
  }
}
Veuillez noter : La réponse de cet endpoint permettra d’interroger les 800 derniers Posts pour une List donnée
I