Passer au contenu principal

​
Bien démarrer avec les endpoints de gestion des Bookmarks

Ce guide de démarrage rapide vous aidera à effectuer votre première requête vers les endpoints de gestion des Bookmarks à 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é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 identifiants requis. Assurez-vous d’enregistrer toutes les informations d’identification dans un emplacement sécurisé.

​
Étapes pour créer une requête de gestion des Bookmarks

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 ici 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 “Bookmarks” et sélectionnez “Create a Bookmark”. Deuxième étape : authentifier votre requête Pour effectuer une requête réussie vers cet endpoint, vous devrez utiliser OAuth 2.0 Authorization Code Flow with PKCE. Vous pouvez générer un access token dans Postman. Rendez-vous dans l’onglet “Authorization” et sélectionnez “OAuth 2.0”. Dans cet onglet, veillez à suivre ces étapes :
  1. Nommez votre jeton
  2. Sélectionnez le Grant Type “Authorization Code (with PKCE)”
  3. Mettez à jour les paramètres : Callback URL - https://www.example.com Celle-ci doit correspondre à la Callback URL que vous avez définie sur votre page des paramètres d’authentification dans le developer portal. Auth URL - https://x.com/i/oauth2/authorize Access Token URL - https://api.x.com/2/oauth2/token Client ID - Copiez-collez l’OAuth 2.0 client ID depuis le developer portal Client Secret - Copiez-collez l’OAuth 2.0 client ID depuis le developer portal. Vous n’en aurez besoin que si vous utilisez un type d’App “confidential client”.
  4. Mettez à jour les scopes avec les valeurs suivantes : post.read users.read bookmark.write
  5. Renseignez le champ state avec “State”
  6. Cliquez sur “Generate Token”
  7. Cliquez sur l’icône d’enregistrement pour enregistrer les modifications du dossier.
Il est possible que vous receviez un message indiquant que vous n’êtes pas connecté à X. Si vous obtenez cette erreur, connectez-vous dans Postman au compte X pour le compte duquel vous tentez de publier. Troisième étape : spécifier un utilisateur Avec cet endpoint, vous devez spécifier l’ID de l’utilisateur dont vous souhaitez obtenir les abonnés dans la réponse. Par exemple, l’ID utilisateur de @XDevelopers est 2244994945. Dans Postman, accédez à l’onglet “Params” et saisissez l’ID de votre compte ou d’un utilisateur authentifié comme valeur du paramètre id.
KeyValue
id2244994945
Quatrième étape : spécifier le Post que vous souhaitez ajouter aux Bookmarks Accédez à l’onglet “Body” et assurez-vous que l’ID de Post correspond à celui que vous souhaitez enregistrer dans vos Bookmarks. La charge utile JSON devrait ressembler à l’exemple ci-dessous. 
      {"tweet_id": "1460323737035677698"}
Étape cinq : 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": {
       "bookmarked": true
   }
}
Pour supprimer un Post, sélectionnez la requête « Remove a Bookmark » également située dans le dossier « Bookmarks » de la collection X API v2 chargée dans Postman. Commencez par renseigner l’identifiant de l’utilisateur pour le compte duquel vous effectuez la requête comme valeur de la colonne « id ». Cet endpoint requiert également l’identifiant du Post que vous souhaitez supprimer. Ensuite, dans l’onglet « Params », saisissez l’identifiant du Post que vous souhaitez supprimer comme valeur de la colonne « tweet_id ». Lorsque votre requête DELETE réussit, vous recevez une réponse similaire à l’exemple suivant : 
{
   "data": {
       "bookmarked": false
   }
}
⌘I