Saltar al contenido principal

Resumen

API Keys es donde creas y gestionas las keys que autentican las llamadas a las APIs de CXF. Cada key puede activarse o desactivarse, y opcionalmente restringirse a URLs e IPs específicas. Las keys se pasan como el api-key al llamar a la Contact API.

Dónde encontrarlo

Settings → API Keys.

Properties

PropertyTipoRequeridoDescripción
TitlestringUn nombre descriptivo para la key.
DescriptionstringNoUna nota opcional sobre para qué sirve la key.
API KeystringAutoEl valor de key generado, mostrado enmascarado (solo los últimos caracteres son visibles).
Allowed URLsarrayNoURLs permitidas para usar la key. Vacío = todas las URLs permitidas. Soporta wildcards, ej. https://*.example.com/*.
Allowed IP AddressesarrayNoIPs permitidas para usar la key. Vacío = todas las IPs permitidas.
EnabledbooleanNoSi la key está activa. Por defecto activa.

Comportamiento y reglas

  • Una key sin URLs ni IPs permitidas muestra “No restrictions (allows all URLs and IPs)”.
  • Usa el toggle Enabled para desactivar una key sin eliminarla.
  • Crea una key con New API Key; gestiona las existentes con Edit y Delete.

Gobernanza y permisos

Solo un super admin o un Master puede crear, editar y eliminar API Keys.

Relacionado

API & Developers

Las APIs contra las que autentican estas keys.

Contact API authentication

Cómo se usa el api-key en las requests.