Passer au contenu principal

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

Ce guide de démarrage rapide vous aidera à effectuer votre première requête vers les endpoints de gestion des abonnements à l’aide de Postman. Si vous souhaitez voir des exemples de code dans différents langages, veuillez consulter notre dépôt GitHub X API v2 sample code.

​
Prérequis

Pour suivre ce guide, vous devez disposer 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 :

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

​
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 ici l’outil Postman afin de simplifier le processus. Pour charger la collection Postman de X API v2 dans votre environnement, cliquez sur le bouton suivant :
Une fois la collection X API v2 chargée dans Postman, accédez au dossier “Follows” et sélectionnez “Follow a user ID”.  

​
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 avec cet endpoint, vous devez authentifier votre requête en utilisant soit 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 — en particulier votre API Key, votre Clé secrète de l’API, l’Access Token utilisateur OAuth 1.0a et le secret d’Access Token utilisateur OAuth 1.0a — dans Postman. Pour cela, sélectionnez l’environnement nommé « X API v2 » dans le coin supérieur droit de Postman, puis 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 intégrées dans l’onglet Authorization de la requête si vous avez effectué cette étape correctement.  

​
Étape trois : préciser qui va suivre qui

Les endpoints de gestion des abonnements prennent deux ID : un pour l’utilisateur source (l’utilisateur qui souhaite s’abonner à ou se désabonner d’un autre utilisateur) et un pour l’utilisateur cible (l’utilisateur qui sera suivi ou dont on se désabonne). L’ID de l’utilisateur source doit correspondre à l’ID de l’utilisateur authentifié. Dans ce cas, vous pouvez indiquer l’ID de votre propre compte. Vous pouvez trouver votre ID de deux façons :
  1. En utilisant l’endpoint user lookup by username, vous pouvez fournir un nom d’utilisateur et recevoir le champ id. 
  2. En consultant votre Access Token, vous constaterez que la partie numérique correspond à votre ID utilisateur.  
L’ID cible peut être n’importe quel ID utilisateur valide. Par exemple, l’ID utilisateur de @XDevelopers est 2244994945. Dans Postman, allez à l’onglet “Params” et saisissez votre ID dans la colonne “Value” de la variable de chemin id. Allez à l’onglet “Body” et indiquez 2244994945 (l’ID utilisateur de @XDevelopers) comme valeur pour le paramètre target_user_id. Veillez à ne pas inclure d’espaces avant ou après un ID.
KeyValue
id(votre ID utilisateur)
target_user_id2244994945
Si vous cliquez sur le bouton “Send”, vous recevrez un objet de réponse contenant l’état de la relation :
  • Si vous recevez “following”: true, alors l’id suit bien le target_user_id.
  • Si vous recevez “pending”: true, alors le target_user_id est protégé et doit accepter votre demande d’abonnement.

​

Quatrième étape : envoyez votre requête et examinez la réponse Une fois tout configuré, cliquez sur le bouton « Send » et vous recevrez la réponse suivante : 
    "data": {
        "following": true,
        "pending_follow": false
    }
}
De même, si vous vouliez arrêter de suivre un utilisateur, vous utiliseriez la requête « Unfollow a user ID » dans la même collection Postman. En revanche, les paramètres source_user_id et target_user_id doivent être transmis comme variables de chemin via l’endpoint d’unfollow.
⌘I