Guides
Guide d’intégration
Cette page présente plusieurs outils et concepts essentiels à connaître lors de l’intégration des endpoints de gestion des Favoris à votre système. Nous avons réparti la page en plusieurs sections :
Avant d’aborder certains concepts clés qui vous aideront à intégrer cet endpoint, nous vous recommandons de vous familiariser avec :
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, veuillez consulter la page “Utiliser Postman”.
Vous souhaitez utiliser cet endpoint avec du code dans votre langage de programmation préféré ? Nous proposons plusieurs exemples de code à utiliser comme point de départ sur notre page GitHub.
Profitez de l’une des bibliothèques tierces créées 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é.
Tous les endpoints de la X API v2 exigent que vous authentifiiez vos requêtes à l’aide d’un ensemble d’identifiants, également appelés clés et jetons.
Ces endpoints nécessitent l’utilisation du flux OAuth 2.0 Authorization Code avec PKCE, ce qui signifie que vous devez utiliser un ensemble de clés et des Access Tokens utilisateur pour exécuter 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 à l’aide d’une URL Authorize.
Veuillez noter qu’OAuth 2.0 peut être complexe à utiliser. Si vous n’êtes pas familiarisé 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.
Pour obtenir un ensemble d’identifiants d’authentification compatibles avec les endpoints de la X API v2, vous devez disposer d’un compte développeur, configurer un Project dans ce compte et créer une App développeur au sein de ce Project. Vous pourrez ensuite retrouver vos clés et jetons dans votre App développeur.
Chaque jour, plusieurs milliers de développeurs envoient des requêtes à l’X API. Pour aider à gérer le volume de ces requêtes, des limites de taux sont appliquées à chaque endpoint, ce qui limite 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 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, quel que soit l’App développeur. Il existe une limite de taux utilisateur de 180 requêtes par fenêtre de 15 minutes pour la méthode GET. Avec la méthode GET de l’endpoint Bookmarks lookup, vous recevrez jusqu’à 800 de vos Posts ajoutés aux favoris les plus récents. En outre, il existe une limite de taux utilisateur de 50 requêtes par 15 minutes pour les méthodes POST et DELETE.
⌘I