Guide d’intégration

Cette page présente plusieurs outils et concepts essentiels à connaître lors de l’intégration des endpoints Lists à votre système. Nous avons scindé la page en plusieurs sections :

• Outils pratiques
• Concepts clés
• Authentification
• Developer portal, Projects, and Apps
• Limites de taux

​

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 pour tester un endpoint. Chaque requête Postman inclut tous les paramètres de chemin et de corps afin de vous aider à comprendre rapidement ce qui est disponible. Pour en savoir plus sur nos collections Postman, consultez notre page “Utiliser Postman”. 

​

Exemples de code

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

​

Bibliothèques tierces

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

​

Concepts clés

​

Authentification

Tous les endpoints de la X API v2 exigent d’authentifier vos requêtes à l’aide d’un ensemble d’identifiants, également appelés clés et jetons.

Ces endpoints requièrent l’utilisation du Contexte utilisateur OAuth 1.0a, ce qui signifie que vous devez utiliser un ensemble de clés d’API et des Access Tokens utilisateur pour effectuer une requête avec succès. Les Access Tokens doivent être associés à l’utilisateur pour le compte duquel vous effectuez la requête. Si vous souhaitez générer un ensemble d’Access Tokens pour un autre utilisateur, celui-ci doit autoriser ou authentifier votre App en utilisant le flux OAuth à 3 étapes.

Veuillez noter qu’OAuth 1.0a peut être délicat à 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 pour authentifier correctement vos requêtes.  

​

developer portal, 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 à un compte développeur, configurer un Project dans ce compte, puis créer une developer App au sein de ce Project. Vous pourrez ensuite trouver vos clés et jetons dans votre App développeur.  

​

Limites de taux

Chaque jour, des dizaines de milliers de développeurs envoient des requêtes vers la X API. Pour aider à gérer l’important 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 au nom de votre App ou d’un utilisateur authentifié.

Ces endpoints sont soumis à des limites de taux 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, et ce, quel que soit l’App développeur.

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

Endpoint	Méthode HTTP	Limite de taux
/2/lists	POST	300 requêtes par 15 minutes
/2/lists/:id	DELETE / PUT	300 requêtes par 15 minutes