Saltar al contenido
API v1 · https://bentho.org/api
PATCH/api/companies/{espacio}/api-config

Límites, cuota diaria e IPs del espacio

Decide si la API del espacio está activa, cuántas peticiones por segundo acepta, su ráfaga, su cuota diaria y qué IPs pueden llamar. Se valida el resultado: lo guardado más lo que mandas.

  • PERMISOescribe
  • CRÉDITOSno gasta
  • AUTENTICACIÓNBearer bth_…

PARÁMETROS

CAMPOTIPOREQUERIDOQUÉ ES
espaciostringSÍEl id del espacio (sale en GET /api/companies).

CUERPO · JSON

CAMPOTIPOREQUERIDOQUÉ ES
activaboolnoApaga o enciende la API del espacio. Ojo: una clave que la apaga se deja fuera a sí misma.
solicitudes_por_segundointno1 – 1000. Por defecto, 2.
rafagaintno1 – 5000 y no menor que solicitudes_por_segundo. Por defecto, 120.
cuota_diariaint | nullno100 – 100 000 000 peticiones al día (UTC). null = sin tope.
ips_permitidasstring[]noHasta 100 IPs o rangos CIDR, v4 o v6. [] = cualquiera. Ver Lista de IPs.

RESPUESTA 200

Los cinco campos, como quedaron guardados (las IPs, ya normalizadas).

CAMPOTIPOQUÉ ES
configobjectactiva, solicitudes_por_segundo, rafaga, cuota_diaria, ips_permitidas.

GET /API/COMPANIES/{ESPACIO}/API-CONFIG DEVUELVE ADEMÁS

CAMPOTIPOQUÉ ES
techo_por_minutointEl tope global por clave (120 por defecto).
usoobjectDel día (UTC): solicitudes, atendidas, rechazadas y por_motivo (apagada, ip, cuota, tasa).
clavesarrayTus claves que alcanzan este espacio, sin secreto.
contratadoboolSi el espacio tiene el módulo «Bentho API».

ERRORES DE ESTA RUTA · SIEMPRE {"detail": …}

STATUSCUÁNDODETAIL LITERAL
403Sin el módulo contratadoEste espacio no tiene contratado el módulo «Bentho API».
403Clave de solo lecturaTu cuenta es de solo lectura en este espacio.
404El espacio no existeEspacio no encontrado.
422Ráfaga menor que la tasa«rafaga» no puede ser menor que «solicitudes_por_segundo»: el cubo se vaciaría antes de rellenarse un segundo.
422IP mal escrita«<valor>» no es una IP ni un rango CIDR válido.
422Más de 100 IPsComo máximo 100 IPs o rangos.
422Campo desconocidoCampos desconocidos: ['<campo>', …].

Y los de cualquier ruta —clave inválida, cuenta no al día, IP, límites—, en Errores, límites y créditos.

CONVIENE SABER

  • Guardar reinicia los cubos del espacio, no los contadores del día.
  • Estos límites se aplican solo a las claves. El Studio, con tu sesión, sigue entrando aunque apagues la API.