Welke variabelen zitten er in de API Response Header?
Voor alle Brightspace API-apps (die momenteel niet op onze API-snelheidsbeperkende SafeList staan) bevat elke Brightspace API-reactie nu 3 extra gegevens in de responsheader:
X-Rate-Limit-Resterend - het resterende aantal credits dat beschikbaar is binnen de huidige minuut. Elke minuut wordt deze waarde teruggezet naar de volledige grootte van de emmer. Elke API-aanroep binnen de huidige minuut zal afnemen deze waarde door X-Request-Kosten.
X-Rate-Limit-Reset - Geeft de ontwikkelaar de hoeveelheid tijd, in seconden, totdat hun bucket wordt gereset. Deze waarde wordt bepaald door de klok van de Brightspace-server.
X-Request-Kosten - informeert de ontwikkelaar over het aantal credits dat de huidige API-routekosten zijn. Voorlopig staat deze waarde altijd op 10.
De koptekstwaarden zijn er niet als ik een 429 krijg. Help!
Als de Brightspace-API wordt aangeroepen en een 429: Te veel verzoeken antwoord wordt geretourneerd, verschillen de geretourneerde API-responsheaderwaarden van andere antwoordwaarden. We hebben besloten om onze 429-respons af te stemmen op de Internet standaard. Daarom nemen we in alle 429 reacties een andere, maar standaardwaarde op:
Opnieuw proberen-Na - biedt de ontwikkelaar de hoeveelheid tijd, in seconden, totdat hun bucket wordt gereset en ze opnieuw met succes Brightspace API-aanroepen kunnen uitvoeren.
Hoe kan ik de Response Headers zien?
De eenvoudigste manier om deze variabelen in de responsheader te "zien" is via Postbode. Voer binnen Postman een Brightspace API-verzoek uit (bijvoorbeeld onze Wie ben ik route). Meestal wordt in Postman, nadat u een verzoek hebt verzonden, in uw standaardweergave de API-antwoordtekst weergegeven. Om de API Response Headers te zien, klikt u op "Headers".
Waarom zie ik ze niet?
Er kunnen een paar redenen zijn waarom u deze waarden van de API-responsheader nog steeds niet kunt zien:
- U gebruikt de knop API-testtool. De API-testtool is een geweldige bron voor ontwikkelaars. Maar het gebruikt een PHP "wrapper" -interface om API-verzoeken te verzenden en API-antwoorden te ontvangen. Een vindingrijke ontwikkelaar kan hun eigen API-testtool maken en voeg er Header Response-waarden aan toe als ze dat willen. Als je dat doet, laat het ons dan weten!
- U gebruikt een Brightspace API-app die op onze veilige lijst voor snelheidsbeperking staat. Voor deze apps is geen API-snelheidsbeperking afgedwongen en daarom zijn deze reactiewaarden niet nodig.
- Binnen Postman kan het zijn dat uw Brightspace-cookies in de cache zijn opgeslagen, waardoor het Bearer-token kan worden overschreven. In dit scenario is het mogelijk dat we de waarden van de Rate Limiting Response Header niet opnemen. Verwijder gewoon uw cookies in Postman en zorg ervoor dat u het OAuth 2.0-toegangstoken als toondertoken opneemt in de header van uw API-verzoek.