Passer au contenu principal

​
Bien démarrer avec l’endpoint de recherche Spaces

Ce guide de démarrage rapide vous aidera à effectuer votre première requête vers l’endpoint 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 référentiel GitHub d’exemples de code X API v2.
PrérequisPour 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 à 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

Étape une : Commencez 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 ici 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 « Search Spaces ».   Étape deux : 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, cet endpoint nécessite d’authentifier votre requête avec OAuth 2.0 App-Only ou OAuth 2.0 Autorisation par code avec PKCE. Par souci de 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) dans 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é de la liste déroulante des environnements). Ces variables seront automatiquement intégrées dans l’onglet d’autorisation de la requête si vous avez procédé correctement.   Étape trois : Créez une requête de recherche Cet endpoint accepte du texte comme requête de recherche. Contrairement à d’autres endpoints de recherche, il n’accepte pas les opérateurs, le regroupement ni les opérateurs logiques. Pour cet exercice, nous utiliserons « hello » comme requête simple. Dans Postman, accédez à l’onglet « Params » et saisissez cet identifiant d’utilisateur dans la colonne « Value » du paramètre id.
KeyValue
queryhello
Étape quatre : Identifiez et spécifiez les fields que vous souhaitez récupérer Si vous cliquez sur le bouton « Send » après l’étape trois, vous recevrez l’ID des Spaces et leur état, qui sont les seuls fields de l’objet Space retournés 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 supplémentaire title dans l’objet principal Spaces.
  • L’objet utilisateur complet de l’ID du 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/search?query=hello&space.fields=creator_id&expansions=creator_id&user.fields=created_at Étape cinq : Envoyez votre requête et examinez la réponse Une fois que tout est configuré, cliquez sur le bouton « Send » et vous recevrez 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