¿Qué variables hay en el encabezado de respuesta de la API?
Para todas las aplicaciones de API de Brightspace (que no están actualmente en nuestra lista segura de limitación de velocidad de API), cada respuesta de API de Brightspace ahora incluye 3 datos adicionales en su encabezado de respuesta:
X-Tasa-Límite-Restante - el número restante de créditos disponibles dentro del minuto actual. Cada minuto, este valor se restablece al tamaño completo del cubo. Cada llamada a la API dentro del minuto actual disminuir Este valor por X-Costo-Solicitud.
Restablecimiento del límite de velocidad X - proporciona al desarrollador la cantidad de tiempo, en segundos, hasta que se reinicia su bucket. Este valor es controlado por el reloj del servidor de Brightspace.
X-Costo-Solicitud - informa al desarrollador de la cantidad de créditos que cuesta la ruta actual de la API. Por ahora, este valor siempre se establecerá en 10.
Los valores de encabezado no están allí cuando obtengo un 429. ¡Ayuda!
Si se llama a la API de Brightspace, y un 429: Demasiadas solicitudes response, los valores del encabezado de respuesta de la API devueltos difieren de otros valores de respuesta. Decidimos alinear nuestra respuesta 429 con la Estándar de Internet. Por lo tanto, incluimos un valor diferente, pero estándar, en todas las respuestas 429:
Reintentar después - proporciona al desarrollador la cantidad de tiempo, en segundos, hasta que su bucket se restablezca y pueda volver a realizar con éxito las llamadas a la API de Brightspace.
¿Cómo puedo ver los encabezados de respuesta?
La forma más fácil de "ver" estas variables de encabezado de respuesta es a través de Postman. Dentro de Postman, realice una solicitud de API de Brightspace (por ejemplo, nuestro WhoAmI (en inglés) ruta). Por lo general, en Postman, después de enviar una solicitud, la vista predeterminada mostrará el cuerpo de la respuesta de la API. Para ver los encabezados de respuesta de la API, simplemente haga clic en "Encabezados".
¿Por qué no los veo?
Puede haber algunas razones por las que aún no pueda ver estos valores de encabezado de respuesta de API:
- Está utilizando el método Herramienta de prueba de API. La herramienta de prueba de API es un gran recurso para los desarrolladores. Sin embargo, utiliza una interfaz "envoltura" de PHP para enviar solicitudes de API y recibir respuestas de API. Un desarrollador ingenioso puede: crear su propia herramienta de prueba de API y agregarle valores de Respuesta de encabezado si lo desean. Si es así, ¡háganoslo saber!
- Está utilizando una aplicación API de Brightspace que se encuentra en nuestra lista segura de limitación de velocidad. Estas aplicaciones no tienen la limitación de velocidad de API aplicada y, por lo tanto, estos valores de respuesta no son necesarios.
- Dentro de Postman, es posible que tenga sus cookies de Brightspace almacenadas en caché, lo que puede anular el token de portador. En este escenario, es posible que no incluyamos los valores del encabezado de respuesta de limitación de velocidad. Simplemente elimine sus cookies en Postman y asegúrese de incluir el token de acceso OAuth 2.0 como token de portador en el encabezado de su solicitud de API.