Prise en main

​

Bien démarrer avec l’endpoint de recherche des blocages

Ce guide de prise en main vous aidera à effectuer votre première requête vers l’endpoint de recherche des blocages à l’aide de Postman.

Si vous souhaitez consulter des exemples de code dans différents langages, veuillez visiter notre dépôt GitHub X API v2 sample code.

​

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 identifiants requis. Veillez à enregistrer toutes les informations d’identification dans un emplacement sécurisé.

​

Étapes pour créer une requête de consultation des blocages

​

Première étape : commencez 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 importer la collection Postman X API v2 dans votre environnement, veuillez cliquer sur le bouton suivant :

Ajouter X API v2 à Postman

Une fois la collection X API v2 chargée dans Postman, accédez au dossier « Blocks » et sélectionnez « Blocks 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 en utilisant soit le Contexte utilisateur OAuth 1.0a, soit OAuth 2.0 Autorisation par code avec PKCE.

Dans cet exemple, nous allons utiliser le Contexte utilisateur OAuth 1.0a.

Vous devez ajouter vos clés et jetons — spécifiquement votre API Key, votre Clé secrète de l’API, votre OAuth 1.0a user Access Token et votre OAuth 1.0a user Access Token Secret — dans Postman. Pour cela, 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 Authorization de la requête si vous avez effectué cette opération correctement.  

​

Troisième étape : spécifier un utilisateur

Avec cet endpoint, vous devez indiquer votre id utilisateur ou celui d’un utilisateur authentifié pour voir qui vous avez bloqué.

Dans Postman, ouvrez l’onglet « Params » et saisissez ce nom d’utilisateur dans la colonne « Value » de la variable de chemin id (en bas de la section), en veillant à ne pas inclure d’espaces avant ou après les noms d’utilisateur.  

Key	Value
id	(votre id utilisateur)
max_results	5

​

Quatrième étape : identifier et préciser 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 de l’objet utilisateur : id, name et username.

Si vous souhaitez recevoir des fields supplémentaires au‑delà de id, name et username, vous devrez spécifier ces fields dans votre requête avec les paramètres fields et/ou expansions.

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

1. Le field supplémentaire user.created_at dans les objets utilisateur principaux.
2. Les fields par défaut de l’objet Posts épinglés associé pour les utilisateurs retournés : id et text.
3. Le field supplémentaire tweet.created_at dans les objets Post associés.

Dans Postman, accédez à l’onglet « Params » et ajoutez la paire clé:valeur suivante au tableau « Query Params » :

Key	Value	Returned fields
user.fields	created_at	user.created_at
expansions	pinned_tweet_id	tweet.id, tweet.text
tweet.fields	created_at	includes.tweets.created_at

Vous devriez maintenant voir une URL similaire avec votre propre user ID au lieu de l’URL de TwitterDev à côté du bouton « Send » :

      https://api.x.com/2/users/2244994945/blocking?user.fields=created_at&expansions=pinned_tweet_id&tweet.fields=created_at

​

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

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

    {
  "data": [
    {
      "created_at": "2008-12-04T18:51:57.000Z",
      "id": "17874544",
      "username": "TwitterSupport",
      "name": "Twitter Support"
    },
    {
      "created_at": "2007-02-20T14:35:54.000Z",
      "id": "783214",
      "username": "Twitter",
      "name": "Twitter"
    },
    {
      "pinned_tweet_id": "1389270063807598594",
      "created_at": "2018-11-21T14:24:58.000Z",
      "id": "1065249714214457345",
      "username": "TwitterSpaces",
      "name": "Spaces"
    },
    {
      "pinned_tweet_id": "1293595870563381249",
      "created_at": "2007-05-23T06:01:13.000Z",
      "id": "6253282",
      "username": "XAPI",
      "name": "X API"
    }
  ],
  "includes": {
    "tweets": [
      {
        "created_at": "2021-05-03T17:26:09.000Z",
        "id": "1389270063807598594",
        "text": "désormais, toute personne ayant 600 abonnés ou plus peut animer un Space.\n\nd'après ce que nous avons appris, ces comptes ont de bonnes chances de vivre une expérience d'animation réussie grâce à leur audience existante. avant de permettre à tout le monde de créer un Space, nous nous concentrons sur quelques aspects. 🧵"
      },
      {
        "created_at": "2020-08-12T17:11:04.000Z",
        "id": "1293595870563381249",
        "text": "X API v2 : Accès anticipé disponible\n\nAujourd'hui, nous avons annoncé l'accès anticipé aux premiers endpoints de la nouvelle Twitter API !\n\n#TwitterAPI #EarlyAccess #VersionBump https://t.co/g7v3aeIbtQ"
      }
    ]
  }

​

Sixième étape : Paginer vos résultats

Vous remarquerez qu’un objet meta se trouve au bas de la réponse. Si vous recevez un next_token, cela indique qu’il existe une autre page de résultats à récupérer. Pour obtenir la page suivante, récupérez la valeur du champ next_token et ajoutez-la à la requête en tant que valeur d’un paramètre supplémentaire nommé pagination_token.  

Clé	Valeur
pagination_token	1D3PU6DRII9HEZZZ

Si vous envoyez la requête après avoir ajouté ce paramètre supplémentaire, les cinq résultats suivants seront renvoyés dans la charge utile suivante, puisque nous avons défini max_results sur 5 à l’étape trois. Vous pouvez continuer à répéter ce processus jusqu’à ce que tous les résultats aient été renvoyés, mais vous pouvez aussi utiliser le paramètre max_results pour demander jusqu’à 1000 utilisateurs par requête, afin de réduire le besoin de pagination.