Configuración del cliente API

Prev Next

Al configurar o editar un cliente API, puede configurar los siguientes ajustes específicos del cliente.

Configuración

Descripción

Notas

Límite de frecuencia de cliente

Establecer el costo máximo por minuto de complejidad de consulta para este cliente.

Si este valor excede el valor establecido para el límite de tarifa del Cliente establecido en el nivel del sitio, se utilizará el límite del nivel del sitio en su lugar.

Caducidad del token

Esto establece el tiempo que los tokens de acceso serán válidos antes de expirar.

La duración predeterminada es de 1 día.

Cambiar esta configuración solo afecta a los tokens nuevos; cualquier token existente seguirá respetando el tiempo de caducidad establecido en el momento de su creación.

Respuesta de error

Esta configuración determina cuánta información se proporcionará en las respuestas de API cuando se produzcan errores para este cliente. Selecciona una de las siguientes opciones:

  • Valor por defecto del sitio (X): Este cliente utilizará la opción seleccionada para la respuesta de error por defecto en la configuración de la API de todo el sitio

  • Ninguna: Las respuestas API no devolverán ninguna información específica sobre el error

  • Normal: Las respuestas de la API mostrarán información específica sobre por qué ocurrió el error

  • Desarrollador: Las respuestas de API devolverán información específica sobre por qué ocurrió el error, incluido un seguimiento completo de la pila

Por defecto, los clientes utilizarán la opción por defecto del sitio (X). Si la configuración de la respuesta de error por defecto se cambia a nivel del sitio, todos los clientes que utilicen la opción por defecto del sitio (X) comenzarán a utilizar la opción seleccionada.

Lista blanca de IP del cliente API

Los administradores del sitio pueden restringir qué direcciones IP pueden hacer solicitudes usando un cliente de API específico. Esto proporciona mayor seguridad y control sobre cómo interactúan los sistemas externos con tu sitio de Totara a través de la API externa.

¿Por qué usar la lista blanca de IP?

Anteriormente, cualquier sistema con acceso a un ID de cliente y secreto de API válido podía usar la API externa, independientemente de dónde se originó la solicitud. Esto significaba que el uso de la API no podía restringirse a sistemas o redes de confianza. Para abordar esto, se ha agregado un nuevo campo de direcciones IP permitidas a la configuración del cliente API. Esto permite a los administradores especificar qué direcciones IP se permiten para enviar solicitudes usando el cliente de API seleccionado. Por defecto, todas las direcciones IP están permitidas. Sin embargo, puedes elegir restringir el acceso especificando las IP permitidas en este nuevo campo.

Dónde encontrar la configuración

Para usar esta característica, asegúrese de que la API externa esté habilitada y que se haya creado al menos un cliente de API. Consulte las siguientes guías para obtener instrucciones de configuración:

Una vez que estén en su lugar:

  1. Ir al menú de acceso rápido > Desarrollo > API > Clientes API > Editar configuración del cliente

  2. Localice el nuevo campo Direcciones IP permitidas.

  3. Deje el campo vacío para permitir solicitudes de cualquier dirección IP (comportamiento por defecto).

  4. Para restringir el acceso, introduzca una o más direcciones IP permitidas, cada una en una línea separada.

Cuando se realiza una solicitud entrante usando este cliente API:

  • Si la solicitud se origina en una dirección IP permitida, la llamada a la API continuará como de costumbre.

  • Si la dirección IP no está en la lista blanca, la solicitud será bloqueada. El tipo de respuesta de error depende de la configuración de “Respuesta de error”:

    • Normal: Devuelve una respuesta prohibida 403.

    • Ninguna: Devuelve una respuesta 404 No encontrada.

    • Desarrollador: Devuelve información de depuración a nivel del desarrollador que explica por qué se bloqueó la solicitud.

El nuevo campo Direcciones IP permitidas admite:

  • Dirección IP completa: 192.168.0.1

  • Dirección IP parcial: 192.168 (coincide con cualquier dirección que comience con este valor)

  • Rango de IP: 192.168.0.10-20 (coincide con todas las direcciones de .10 a .20)

  • Anotación CIDR: 231.54.211.0/20

Join the Totara Community for more resources to help you get the most out of Totara. 


© Copyright 2026 Totara Learning Solutions. All rights reserved.