Passer au contenu principal

​
Bien démarrer avec les endpoints de recherche Spaces

Ce guide de démarrage rapide vous aidera à effectuer votre première requête vers l’un des endpoints de recherche Spaces avec un ensemble de fields spécifiés, à l’aide de Postman. Si vous souhaitez voir des exemples de code dans différents langages de programmation, veuillez consulter notre dépôt X API v2 sample code GitHub.

​
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 obtenir 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. Assurez-vous d’enregistrer toutes les informations d’identification dans un emplacement sécurisé.

​
Étapes pour créer une requête de recherche Spaces

Pour cet exemple, nous allons envoyer une requête vers l’endpoint de recherche des Spaces par ID de créateur, mais vous pouvez appliquer les enseignements de ce guide Bien démarrer à d’autres requêtes de recherche également. 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 allons utiliser l’outil Postman pour simplifier le processus. Pour charger la collection Postman X API v2 dans votre environnement, veuillez cliquer sur le bouton suivant :
Une fois la collection X API v2 chargée dans Postman, accédez au dossier Spaces et trouvez la requête « Lookup Spaces created by one or more users ».   Deuxième étape : authentifier votre requête Pour envoyer correctement une requête à la X API, vous devez vérifier que vous disposez des autorisations nécessaires. Pour ce faire, cet endpoint exige d’authentifier votre requête avec OAuth 2.0 App-Only ou OAuth 2.0 Autorisation par code avec PKCE. Par simplicité, nous utiliserons OAuth 2.0 App-Only pour cette requête, mais vous devrez utiliser l’une des autres méthodes d’authentification si vous souhaitez demander des métriques privées ou des Spaces d’un utilisateur privé.  Pour utiliser OAuth 2.0 App-Only, vous devez ajouter vos clés et jetons, en particulier l’App Access Token (également appelé App-only Bearer Token) à Postman. Pour ce faire, sélectionnez l’environnement nommé « X API v2 » dans le coin supérieur droit de Postman et ajoutez 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 de l’environnement). Ces variables seront automatiquement reprises dans l’onglet d’autorisation de la requête si vous avez effectué cette opération correctement.   Troisième étape : identifier et spécifier l’utilisateur pour lequel vous souhaitez récupérer des Posts Vous devez indiquer, dans la requête, l’utilisateur pour lequel vous souhaitez récupérer des Spaces en direct ou à venir. Dans cet exemple, nous passerons un seul ID d’utilisateur. Les ID d’utilisateur sont simplement la valeur numérique représentant un identifiant de compte que vous pouvez trouver dans l’URL du profil d’un compte. Par exemple, le nom d’utilisateur du compte suivant est XDevelopers. https://x.com/XDevelopers Pour convertir ce nom d’utilisateur en ID d’utilisateur, vous devrez utiliser l’endpoint de recherche d’utilisateur avec le nom d’utilisateur et trouver l’ID d’utilisateur numérique dans le payload. Dans le cas de @XDevelopers, l’ID d’utilisateur est 2244994945. Dans Postman, accédez à l’onglet « Params » et saisissez cet ID d’utilisateur dans la colonne « Value » du paramètre id.
KeyValue
id2244994945
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 un id, qui est le seul champ du Space object renvoyé par défaut dans votre réponse. Si vous souhaitez recevoir des fields supplémentaires, vous devrez les spécifier dans votre requête avec les paramètres space.fields ou expansions. Pour cet exercice, nous demanderons trois ensembles supplémentaires de fields provenant d’objets différents :
  • Le field title supplémentaire dans l’objet Spaces principal.
  • Le objet utilisateur complet de l’ID de créateur spécifié
  • 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
space.fieldstitlecreator_id
expansionscreator_idincludes.users.id, includes.users.name, includes.users.username
user.fieldscreated_atincludes.users.created_at
Vous devriez maintenant voir l’URL suivante à côté du bouton « Send » : https://api.x.com/2/spaces/by/creator_ids?user_ids=2244994945&space.fields=creator_id&expansions=creator_id&user.fields=created_at Étape cinq : Envoyez votre requête et examinez la réponse Une fois tout configuré, cliquez sur le bouton « Send » pour recevoir la réponse suivante : 
{
   "data": [
    {
        "creator_id": "2244994945",
        "id": "1zqKVXPQhvZJB",
        "title": "Bonjour le monde 👋",
        "state": "Running"
   },
   "includes": {
       "users": [
           {
               "created_at": "2013-12-14T04:35:55.000Z",
               "name": "Twitter Dev",
               "id": "2244994945",
               "username": "TwitterDev"
           }
       ]
   }
]
}
⌘I