Saltar al contenido

Integraciones API REST y MCP

Gestión de claves API

Cree y proteja credenciales REST, interprete la lista y revoque o sustituya claves de forma segura, incluso después de cambiar de plan.

Revisado el

1. Acceso y alcance

La página Claves API en /api-keys gestiona credenciales para la API REST bajo /api/v1/. Crear claves y utilizar esa API requiere Enterprise o Manufacturer con estado de suscripción active o trialing. Free y Professional no incluyen acceso REST.

Inicie sesión para gestionar sus propias claves. Puede seguir consultando, revocando y eliminando claves existentes tras reducir o cancelar el plan; este acceso de seguridad no restablece el permiso para crear claves o usar REST. Una clave marcada como Activa no demuestra que la suscripción de su propietario siga siendo apta.

2. Crear una clave con nombre

Esta página no tiene selector de permisos o caducidad, ni controles para renombrar o editar el límite de solicitudes. El formulario envía calc:read y projects:read y no establece caducidad. No deduzca endpoints a partir de los nombres de permisos: el enrutador REST actual ofrece cálculo/refrigerantes y health, no lectura de proyectos. La página no ofrece una opción de permiso comodín.

El límite es de diez registros de clave por cuenta, incluidos los revocados, no diez claves activas. Revocar conserva el registro y no libera espacio; eliminar un registro revocado desde la página sí lo libera. Nueva clave se desactiva con diez registros, durante la carga, si falla la lista o sin un plan apto.

  1. Abra Claves API con la sesión iniciada. Espere a que cargue la lista y resuelva cualquier error de carga antes de crear una clave.
  2. Seleccione Nueva clave o Crear clave en el estado vacío. Introduzca un nombre descriptivo que identifique la aplicación o el entorno, sin secretos ni datos de clientes.
  3. Pulse Crear una sola vez y espere el resultado. Se eliminan los espacios de los extremos y el nombre no puede quedar vacío; el servidor admite hasta 255 caracteres. Cancelar cierra el diálogo sin crear la clave.
  4. Tras el éxito, copie la clave completa del panel para guardarla y almacénela de forma segura antes de cerrar el panel, salir de la página o recargar.

3. Visualización única y almacenamiento seguro

Las claves REST comienzan por exk_ seguido de 64 caracteres hexadecimales. El servidor guarda un hash SHA-256 y un prefijo identificador de 12 caracteres, no una copia recuperable de la credencial completa. La clave completa solo se devuelve en la respuesta de creación; la lista no permite revelarla después.

Use el botón de copia y compruebe que la credencial completa llegó al almacén de secretos aprobado. Si el navegador bloquea el portapapeles, copie directamente desde el panel aún visible. El aviso de copia no demuestra por sí solo que el secreto se guardó correctamente. Cerrar el panel borra su valor; recargar o salir hace perder esta oportunidad.

  • Guarde el secreto en un gestor del servidor o configuración de entorno protegida, nunca en código del navegador, repositorios públicos, capturas, URLs, prompts o archivos de cálculo compartidos.
  • Cuando sea posible, use claves con nombres distintos para integraciones diferentes, respetando el límite de registros, para contener un incidente sin sustituir credenciales ajenas a él.
  • Si pierde la clave, no existe una acción para revelarla o recuperarla. Identifique y revoque el registro antiguo y cree y configure otra si su plan lo permite.

4. Interpretar la lista y los contadores

La respuesta de gestión contiene únicamente metadatos explícitos y excluye hash, clave completa e identificador del propietario. La tabla no muestra el contador de solicitudes, permisos, caducidad ni límite individual presentes en los metadatos. Aquí no hay un registro completo de llamadas ni una vista editable de detalles.

El registro de último uso es asíncrono y ocurre después de autenticar y limitar la tasa, antes de comprobar el permiso del endpoint y finalizar el cálculo. Puede retrasarse y no demuestra que el cálculo haya tenido éxito.

VisualizaciónSignificado y limitación
Nombre / ClaveEtiqueta elegida y prefijo seguido de puntos suspensivos; el prefijo no es una credencial utilizable.
Activa / RevocadaIndica si el registro está habilitado o revocado. Activa no certifica la suscripción ni la ausencia de caducidad.
Creada / Último usoFechas con formato del navegador. Nunca indica que no hay fecha de uso registrada, no una garantía completa de auditoría.
Claves activas / totalLos registros activos se cuentan por separado de todos los almacenados. Los revocados siguen contando para el máximo de diez.
Solicitudes / min / Endpoints de cálculoMuestra el valor predeterminado de 100 solicitudes por minuto y seis familias de cálculo; no es un gráfico de consumo ni un historial de llamadas.

5. Autenticación, límites y fallos de solicitudes

En su integración, envíe la clave REST completa en Authorization como credencial Bearer mediante HTTPS. Un prefijo o token MCP no funcionará. Lo siguiente es solo una plantilla de cabecera, no una solicitud para ejecutar. Consulte la referencia del endpoint para las entradas y unidades reales; el ejemplo breve de la página no es una especificación completa.

El límite REST predeterminado es de 100 solicitudes por minuto por clave. Las respuestas que llegan al limitador incluyen X-RateLimit-Limit, X-RateLimit-Remaining y X-RateLimit-Reset; Reset es una marca Unix en segundos. El limitador actual reside en la memoria del proceso del servidor, no es una cuota compartida garantizada entre réplicas. El valor mostrado no garantiza capacidad de procesamiento.

  • 401: compruebe cabecera Bearer ausente o incorrecta, tipo de credencial erróneo, clave truncada o desconocida. Nunca incluya la clave al informar de un error.
  • 403: lea el mensaje para distinguir revocación, caducidad, suscripción no apta o falta de permiso del endpoint. Crear otra clave no soluciona una restricción de suscripción.
  • 429: detenga los reintentos rápidos y espere al reinicio de la ventana. Los fallos de entrada y del motor son distintos de la gestión de claves; conserve el error devuelto en vez de interpretarlo como un resultado válido.

text

Authorization: Bearer <EXCOIL_REST_API_KEY>

6. Revocar primero; eliminar cuando proceda

La página solo muestra Eliminar para filas revocadas. Las acciones comprueban el propietario, incluso tras reducir el plan. No confunda la revocación REST con la de una conexión MCP independiente.

  1. Identifique el registro por nombre y prefijo. Planifique la sustitución de una integración en uso, salvo que una posible filtración exija revocación inmediata.
  2. Pulse Revocar en una fila activa. Lea la confirmación y compruebe el nombre; Cancelar no cambia nada. Confirme Revocar clave solo cuando esté listo para bloquear nuevas solicitudes con ella.
  3. Espere a que termine y se actualice la lista. La fila debe pasar a Revocada, bajar el contador activo y aparecer Eliminar en lugar de Revocar. Una clave revocada no se puede reactivar.
  4. Para quitar el registro restante y liberar espacio, pulse Eliminar en la fila revocada, revise el nombre y confirme Eliminar clave. Esta eliminación permanente no se puede deshacer.

7. Confirmar el resultado y recuperarse de errores

Durante la carga aparece un mensaje de espera. Si falla, la página muestra un error y Reintentar; no confunda un fallo de carga con una cuenta vacía. Una lista vacía cargada correctamente indica que aún no hay claves. Los errores de creación y gestión muestran mensajes del servidor; los de revocación/eliminación también permanecen dentro del diálogo de confirmación.

Durante la revocación/eliminación se desactivan los controles de confirmación para evitar envíos duplicados. Si falla o el resultado es incierto, conserve el mensaje sin secretos, recargue la lista e inspeccione la fila antes de reintentar. Reabrir o recargar actualiza el estado, pero no recupera una clave completa recién creada.

  • Tras una creación de resultado incierto, busque el registro por nombre antes de generar duplicados. Si existe pero no guardó el secreto, revoque y sustituya la clave; no se recupera desde los metadatos.
  • Si Nueva clave sigue inactiva, revise la suscripción, los errores de carga y el total de registros. Revocar por sí solo no reduce ese total.
  • Después del éxito, verifique el estado esperado: Revocada tras revocar; fila ausente tras eliminar. Si persiste la incoherencia después de recargar, no dé por hecha la operación ni exponga secretos al pedir ayuda.

8. Mantener separadas las conexiones MCP

MCP se gestiona en la página independiente /mcp y utiliza tokens Bearer dedicados exm_ para /api/mcp. Las claves REST exk_ no sirven para MCP y los tokens MCP no sustituyen claves REST. Crear y usar MCP requiere Manufacturer con estado active o trialing; Enterprise por sí solo no basta.

MCP usa configuración Bearer manual, no OAuth. Sus tokens tienen ámbitos propios, opciones de validez de 7/30/90 días y revocación independiente; la lectura de proyectos requiere una autorización opcional separada. El formulario REST no ofrece estos controles. Tras reducir el plan también puede listar y revocar conexiones MCP antiguas.

Utilice un cliente compatible y el endpoint mostrado en la página MCP publicada; la disponibilidad no garantiza soporte en todos los clientes de IA. Crear claves REST o conexiones MCP no concede archivos de fabricación, operaciones de facturación ni acceso administrativo. Los detalles de fabricación siguen siendo exclusivos de Manufacturer en los flujos reales del producto.

Las funciones documentadas dependen de la suscripción y de los datos disponibles en el cálculo. Un plano dimensional no constituye una autorización de fabricación.

Todas las guías