Guide d'intégration

Cette page présente les outils et concepts essentiels pour intégrer les endpoints de Listes épinglées.

---

​

Outils utiles

Avant d’aborder quelques concepts clés qui vous aideront à intégrer cet endpoint, nous vous recommandons de vous familiariser avec :

​

Postman

Postman est un excellent outil que vous pouvez utiliser pour tester un endpoint. Chaque requête Postman inclut tous les paramètres de chemin et de corps de la requête afin de vous aider à comprendre rapidement ce qui est à votre disposition. Pour en savoir plus sur nos collections Postman, consultez notre page “Utiliser Postman”.

​

Exemples de code

Vous souhaitez configurer cet endpoint et l’utiliser avec du code dans votre langage de programmation préféré ? Nous proposons plusieurs exemples de code sur notre page GitHub que vous pouvez utiliser comme point de départ.

​

Bibliothèques tierces

Profitez de l’une des bibliothèques tierces maintenues par notre communauté pour vous aider à démarrer. Vous pouvez trouver une bibliothèque compatible avec les endpoints v2 en recherchant le tag de version approprié.

---

​

Concepts clés

​

Authentification

Tous les endpoints de X API v2 requièrent que vos requêtes soient authentifiées à l’aide d’un ensemble d’identifiants, également appelés clés et jetons. Vous pouvez utiliser OAuth 1.0a User Context pour authentifier vos requêtes vers cet endpoint.

Avec OAuth 1.0a User Context, vous devez utiliser un ensemble de clés d’API et de jetons d’accès utilisateur (Access Tokens) pour qu’une requête aboutisse. Les jetons d’accès doivent être associés à l’utilisateur pour le compte duquel vous effectuez la requête. Si vous souhaitez générer un ensemble de jetons d’accès pour un autre utilisateur, celui-ci doit autoriser votre App en utilisant le flux OAuth en 3 étapes.

Veuillez noter qu’OAuth 1.0a peut être difficile à utiliser. Si vous n’êtes pas familier avec cette méthode d’authentification, nous vous recommandons d’utiliser une bibliothèque ou un outil comme Postman.

​

Console de développement, Projects et Apps développeur

Pour obtenir un ensemble d’identifiants d’authentification compatibles avec les endpoints de la X API v2, vous devez vous inscrire pour obtenir un compte développeur, configurer un Project dans ce compte, puis créer une App développeur au sein de ce Project. Vous pourrez ensuite trouver vos clés et jetons dans votre App développeur.

​

Limites de taux

Chaque jour, plusieurs milliers de développeurs envoient des requêtes à la X API. Pour aider à gérer le volume de ces requêtes, des limites de taux sont appliquées à chaque endpoint afin de limiter le nombre de requêtes que vous pouvez effectuer pour le compte de votre App ou pour le compte d’un utilisateur authentifié.

Ces endpoints sont limités au niveau de l’utilisateur, ce qui signifie que l’utilisateur authentifié pour lequel vous effectuez la requête ne peut appeler l’endpoint qu’un certain nombre de fois, toutes Apps de développeur confondues.

Le tableau ci-dessous présente les limites de taux pour chaque endpoint.

Endpoint	Méthode HTTP	Limite de taux
/2/users/:id/pinned_lists	POST	50 requêtes par tranche de 15 minutes
/2/users/:id/pinned_lists/:list_id	DELETE	50 requêtes par tranche de 15 minutes
/2/users/:id/pinned_lists	GET	15 requêtes par tranche de 15 minutes

​

Champs et expansions

L’endpoint GET de X API v2 permet aux utilisateurs de sélectionner précisément quelles données ils souhaitent récupérer à partir de l’API à l’aide d’un ensemble de mécanismes appelés fields et expansions. Le paramètre expansions vous permet de développer les objets référencés dans le payload. Par exemple, la recherche de Listes épinglées vous permet de récupérer les expansions suivantes :

• owner_id

Le paramètre fields vous permet de sélectionner précisément quels fields au sein des différents objets de données vous souhaitez recevoir. Cet endpoint renvoie principalement des objets utilisateur. Par défaut, l’objet List renvoie les champs id et name. Pour recevoir des champs supplémentaires comme list.created_at ou list.description, vous devez les demander explicitement à l’aide d’un paramètre fields.

Nous avons ajouté à notre dictionnaire de données X API v2 un guide sur l’utilisation conjointe des fields et expansions.

Le tableau ci-dessous présente les champs et expansions disponibles pour l’endpoint de recherche :

Endpoint	Champs	Expansions
/2/users/:id/pinned_lists	list.fields, user.fields	owner_id