Quelles sont les variables dans l’en-tête de réponse de l’API ?
Pour toutes les applications API Brightspace (qui ne sont pas actuellement sur notre liste sûre de limitation de débit d’API), chaque réponse API Brightspace inclut désormais 3 données supplémentaires dans son en-tête de réponse :
X-Rate-Limit-Remaining - le nombre restant de crédits disponibles dans la minute en cours. Chaque minute, cette valeur est réinitialisée à la taille complète du compartiment. Chaque appel d’API dans la minute actuelle sera diminuer cette valeur par X-Demande-Coût.
X-Rate-Limit-Reset - fournit au développeur le temps, en secondes, jusqu’à ce que son compartiment se réinitialise. Cette valeur est contrôlée par l’horloge du serveur Brightspace.
X-Request-Cost - informe le développeur du nombre de crédits que coûte l'itinéraire de l’API actuel. Pour l’instant, cette valeur sera toujours définie sur 10.
Les valeurs d’en-tête ne sont pas présentes lorsque j’obtiens un 429. Aidez-moi !
Si l’API Brightspace est appelée, et un 429 : Trop de demandes la réponse est retournée, les valeurs d’en-tête de réponse de l’API renvoyées diffèrent des autres valeurs de réponse. Nous avons décidé d’harmoniser notre réponse 429 avec le norme Internet. Par conséquent, nous incluons une valeur différente, mais standard, dans toutes les réponses 429 :
Réessayer-Après - fournit au développeur le temps, en secondes, jusqu’à ce que son compartiment se réinitialise et qu’il puisse à nouveau effectuer des appels d’API Brightspace avec succès.
Comment puis-je voir les en-têtes de réponse ?
Le moyen le plus simple de « voir » ces variables d’en-tête de réponse est par l’intermédiaire de Postman. Dans Postman, effectuez une demande d’API Brightspace (par exemple, notre WhoAmI route). En règle générale, dans Postman, après avoir envoyé une demande, votre vue par défaut vous montrera le corps de réponse de l’API. Pour voir les en-têtes de réponse de l’API, cliquez simplement sur « En-têtes ».
Pourquoi ne les vois-je pas ?
Il peut y avoir plusieurs raisons pour lesquelles vous ne pouvez toujours pas voir ces valeurs d’en-tête de réponse de l’API :
- Vous utilisez le Outil de test d’API. L’outil de test d’API est une excellente ressource pour les développeurs. Toutefois, il utilise une interface PHP « wrapper » pour envoyer des demandes d’API et pour recevoir des réponses d’API. Un développeur ingénieux peut créer leur propre outil de test d’API et ajoutez-y des valeurs de réponse d’en-tête s’ils le souhaitent. Si vous le faites s’il vous plaît laissez-nous savoir !
- Vous utilisez une application API Brightspace qui se trouve sur notre liste de limitation de débit. Ces applications n’ont pas de limitation de débit API appliquée et, par conséquent, ces valeurs de réponse ne sont pas nécessaires.
- Dans Postman, vous pouvez avoir vos cookies Brightspace mis en cache, ce qui peut remplacer le jeton d’accès. Dans ce scénario, il se peut que nous n’incluions pas les valeurs d’en-tête de réponse de limitation de débit. Supprimez simplement vos cookies dans Postman et assurez-vous que vous intégrez le jeton d’accès OAuth 2.0 en tant que jeton d’accès dans votre en-tête de demande d’API.