Quais variáveis estão no cabeçalho de resposta da API?
Para todos os aplicativos da API do Brightspace (que não estão atualmente em nossa lista segura de limitação de taxa de API), cada resposta da API do Brightspace agora inclui 3 dados adicionais em seu cabeçalho de resposta:
Limite de taxa X restante - o número restante de créditos disponíveis no minuto atual. A cada minuto, esse valor é redefinido para o tamanho total do bucket. Cada chamada de API dentro do minuto atual será diminuir esse valor por Custo de solicitação X.
Redefinição do limite da taxa X - fornece ao desenvolvedor a quantidade de tempo, em segundos, até que o bucket seja redefinido. Esse valor é controlado pelo relógio do servidor Brightspace.
Custo de solicitação X - informa o desenvolvedor sobre o número de créditos que o custo atual da rota da API. Por enquanto, esse valor sempre será definido como 10.
Os valores de cabeçalho não estão lá quando recebo um 429. Ajuda!
Se a API do Brightspace for chamada e um 429: Muitas solicitações response for retornado, os valores do cabeçalho de resposta da API retornados serão diferentes de outros valores de resposta. Decidimos alinhar nossa resposta 429 com o Padrão de Internet. Portanto, incluímos um valor diferente, mas padrão, em todas as 429 respostas:
Tentar novamente - fornece ao desenvolvedor a quantidade de tempo, em segundos, até que o bucket seja redefinido e ele possa executar novamente com êxito as chamadas de API do Brightspace.
Como posso ver os cabeçalhos de resposta?
A maneira mais fácil de "ver" essas variáveis de cabeçalho de resposta é através do carteiro. No Postman, execute uma solicitação de API do Brightspace (por exemplo, nosso QuemEu rota). Normalmente, no Postman, depois de enviar uma solicitação, sua exibição padrão mostrará o corpo da resposta da API. Para ver os cabeçalhos de resposta da API, basta clicar em "Cabeçalhos".
Por que não os estou vendo?
Pode haver alguns motivos pelos quais você ainda não consegue ver esses valores de cabeçalho de resposta da API:
- Você está usando o Ferramenta de teste de API. A API Test Tool é um ótimo recurso para desenvolvedores. Mas, ele usa uma interface "wrapper" PHP para enviar solicitações de API e receber respostas de API. Um desenvolvedor engenhoso pode criar sua própria ferramenta de teste de API e adicione valores de resposta de cabeçalho a ele, se desejarem. Se você fizer isso, por favor nos avise!
- Você está usando um aplicativo da API do Brightspace que está em nossa Lista segura de limitação de taxa. Esses aplicativos não têm a limitação de taxa de API imposta e, portanto, esses valores de resposta não são necessários.
- No Postman, você pode ter seus cookies do Brightspace armazenados em cache, o que pode substituir o token do portador. Nesse cenário, podemos não incluir os valores do Cabeçalho de Resposta de Limitação de Taxa. Basta excluir seus cookies no Postman e garantir que você esteja incluindo o token de acesso OAuth 2.0 como um token de portador no cabeçalho da solicitação de API.