Démarrage rapide

​

Bien démarrer avec le groupe d’endpoints de gestion des Lists

Cette brève présentation vous aidera à effectuer votre première requête vers les endpoints de gestion des Lists à l’aide de Postman.

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

Remarque : Dans cet exemple, nous allons envoyer une requête à l’endpoint Create a List, mais vous pouvez appliquer les notions de ce guide Bien démarrer à d’autres requêtes de gestion également.

Prérequis

Pour suivre ce guide, vous devez disposer d’un ensemble de clés et jetons afin d’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 attendez 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 tous les identifiants dans un emplacement sécurisé.

​

Étapes pour créer une requête de gestion de List

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 :

Ajouter X API v2 à Postman

Une fois la collection X API v2 chargée dans Postman, accédez au dossier “List”, sélectionnez le dossier “Manage List”, puis choisissez “Create a List”.

Deuxième étape : authentifier votre requête

Pour effectuer correctement une requête vers la X API, vous devez vérifier que vous êtes autorisé à le faire. Pour ce faire avec les endpoints de gestion des Posts, 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 (et spécifiquement votre API Key, votre Clé secrète de l’API, l’Access Token utilisateur OAuth 1.0a et le secret de l’Access Token utilisateur OAuth 1.0a) à Postman. Pour ce faire, 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).

Si vous avez effectué cette opération correctement, ces variables seront automatiquement intégrées dans l’onglet d’autorisation de la requête.   Troisième étape : spécifier le nom de la nouvelle List

Lors de la création d’une nouvelle List avec cet endpoint, le nom de la List est un paramètre de corps requis. En option, vous pouvez fournir une description et spécifier si la List est privée.

Dans Postman, accédez à l’onglet “Body” et saisissez le nom de la List comme valeur pour le paramètre name. En outre, si vous souhaitez ajouter une description pour la List, ajoutez simplement une nouvelle clé intitulée description, de la même manière que name, suivie de la description de la List comme valeur. Rendre une List privée suit le même modèle, mais seules les valeurs true ou false sont acceptées pour ce paramètre. 

Key	Value	Parameter type
name	Nom de la List (obligatoire)	body
description	Description de la List (facultatif)	body
private	true ou false (facultatif)	body

Vous devriez maintenant voir une URL similaire à côté du bouton “Send” :

https://api.x.com/2/lists

Quatrième étape : effectuer votre requête et examiner votre réponse

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

{
  "data": {
    "id": "1441162269824405510",
    "name": "Nouvelle liste créée depuis Postman"
  }
}

Si l’objet de réponse renvoyé contient un id et le nom de votre List, vous avez créé la List avec succès.

Pour supprimer une List, sélectionnez la requête « Delete a List » également située dans le dossier « Lists » de la collection X API v2 chargée dans Postman. Cet endpoint requiert l’id de la List que vous souhaitez supprimer. Dans l’onglet « Params », saisissez l’id de la List que vous souhaitez supprimer comme valeur de la colonne id.

En cas de requête DELETE réussie, vous recevrez une réponse semblable à l’exemple suivant :

{
  "data": {
    "deleted": true
  }
}