Démarrage rapide

​

Bien démarrer avec l’endpoint de recherche de List

Ce guide de démarrage rapide vous aidera à effectuer votre première requête vers l’endpoint de recherche de List avec Postman.

Veuillez consulter notre dépôt GitHub X API v2 sample code si vous souhaitez voir des exemples de code dans différents langages.

Remarque : Pour cet exemple, nous allons effectuer une requête vers l’endpoint List lookup by ID, mais vous pouvez appliquer les enseignements de ce guide de démarrage rapide à d’autres requêtes de recherche.

​

Prérequis

Pour suivre ce guide, vous aurez besoin d’un ensemble de clés et jetons pour authentifier votre requête. Vous pouvez générer ces clés et jetons en suivant ces étapes :

• Inscrivez-vous pour un compte développeur et obtenez 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. Veillez à enregistrer toutes les informations d’identification dans un endroit sécurisé.

​

Étapes pour créer une requête de recherche de 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 effectuer une requête vers cet endpoint, mais nous utiliserons ici l’outil Postman pour simplifier le processus.

Pour charger la collection Postman X API v2 dans votre environnement, veuillez cliquer sur le bouton suivant :

Ajouter X API v2 à Postman

Une fois que vous avez chargé la collection X API v2 dans Postman, accédez au dossier “List”, sélectionnez le dossier “List lookup”, puis choisissez “List by ID”.  

Deuxième étape : authentifier votre requête

Pour effectuer correctement une requête vers la X API, vous devez vérifier que vous avez l’autorisation. Pour ce faire avec cet endpoint, vous devez authentifier votre requête avec l’une des méthodes suivantes : App only, OAuth 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 Lists, 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 l’App only Access Token) à 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 d’environnement).

Si vous avez effectué cette opération correctement, ces variables seront automatiquement intégrées dans l’onglet d’autorisation de la requête.  

Troisième étape : identifier et spécifier la List que vous souhaitez récupérer

Vous devez spécifier une List à récupérer dans la requête. 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 de 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” et saisissez votre id dans la colonne “Value” de la variable de chemin id. Veillez à ne pas inclure d’espaces avant ou après un id.

Key	Value
id	84839422 (la List ID)

Quatrième étape : identifier et spécifier les fields que vous souhaitez récupérer

Si vous cliquez sur le bouton “Send” après la troisième étape, vous recevrez dans votre réponse les fields par défaut du List object : id, name.

Si vous souhaitez recevoir des fields supplémentaires, vous devrez les spécifier dans votre requête avec les paramètres list.fields et/ou expansions.

Pour cet exercice, nous demanderons trois ensembles supplémentaires de fields provenant d’objets différents :

• Le field supplémentaire created_at dans l’objet principal Lists.
• Le user object complet en utilisant le paramètre expansions
• 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” :

Key	Value	Returned fields
list.fields	created_at	created_at
expansions	owner_id	includes.users.id, includes.users.name, includes.users.username
user.fields	created_at	includes.users.created_at

Vous devriez maintenant voir une URL similaire à côté du bouton “Send” :

https://api.x.com/2/lists/84839422?list.fields=owner_id&expansions=owner_id&user.fields=created_at

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

Une fois que tout est configuré, cliquez sur le bouton “Send” et vous recevrez une réponse similaire à l’exemple suivant :

{
  "data": {
    "id": "84839422",
    "name": "Comptes X officiels",
    "owner_id": "783214"
  },
  "includes": {
    "users": [
      {
        "name": "Twitter",
        "created_at": "2007-02-20T14:35:54.000Z",
        "username": "Twitter",
        "id": "783214"
      }
    ]
  }
}