API e integraciones
Conecte una aplicación mediante la API de inferencia o la API de entrenamiento de modelos documentadas, credenciales con permisos limitados y las referencias actuales de uso y API.
- Elija el producto de APIDistinga las solicitudes de inferencia de los procesos de entrenamiento de modelos.
- Consulte el contratoUse la documentación y la referencia OpenAPI correspondientes.
- Cree una clave con permisos limitadosGenere una clave de API de cliente y guárdela de forma segura.
- Integre y compruebeEnvíe una solicitud documentada y revise la respuesta.
- Supervise y rote las clavesRevise el uso y revoque o rote las claves cuando corresponda.
Elija el proceso de API adecuado
La API de inferencia procesa solicitudes a modelos; la API de entrenamiento documenta un flujo distinto con presupuestos, trabajos, sesiones y artefactos. No dé por hecho que un endpoint de inferencia inicia un entrenamiento ni que una operación de entrenamiento esté disponible en el contrato de inferencia. Consulte la documentación del producto que vaya a utilizar y confirme que incluya el modelo o la capacidad de entrenamiento que necesita. Siga las estructuras de solicitud y respuesta publicadas; no deduzca nombres de métodos a partir de un SDK conocido de terceros.
- Determine si la aplicación necesita inferencia o entrenamiento de modelos.
- Abra la documentación y la referencia de API del producto correspondiente.
- Confirme que se documenten el modelo y la capacidad necesarios.
Cree y proteja una clave de API
Cree una clave de cliente desde la página autenticada de claves de API y, si la interfaz permite elegir permisos, seleccione únicamente los ámbitos necesarios para la integración. El secreto solo se muestra una vez: guárdelo directamente en un gestor de secretos aprobado. No lo incluya en el control de versiones, en registros ni en código del navegador. Si es posible, identifique las credenciales por aplicación y entorno. Use claves distintas para desarrollo y producción para poder revocar una sin afectar otras integraciones.
- Abra Claves de API desde el espacio de trabajo autenticado.
- Cree una clave con los permisos mínimos necesarios.
- Guarde el secreto de forma segura y manténgalo fuera del código y los registros.
Implemente según el contrato documentado
Siga la guía de API correspondiente para la autenticación, el endpoint, los campos de solicitud, el tratamiento de respuestas y los errores. Mantenga las credenciales en un servidor de confianza, no en código cliente público. Valide las entradas antes de enviarlas, gestione expresamente las respuestas fallidas y no registre encabezados de autorización ni datos sensibles de las instrucciones. Use la referencia OpenAPI para consultar el contrato legible por máquinas. No dé por disponibles operaciones de streaming, multimedia o específicas del proveedor salvo que la documentación actual las indique expresamente.
- Implemente solo las operaciones y los campos documentados para esa API.
- Mantenga las credenciales en el servidor y oculte los secretos en los diagnósticos.
- Gestione los errores documentados y conserve los identificadores de solicitud si se devuelven.
Supervise el uso y gestione las credenciales
Tras integrar la API, consulte la página de uso y compare la actividad de la cuenta con los registros de su aplicación. Investigue los cambios inesperados antes de aumentar el tráfico o crear más credenciales. Si una clave puede haberse expuesto, rótela, actualice el almacén de secretos de la aplicación y compruebe la integración antes de retirar la clave anterior. Revoque las claves que ya no necesite. Los datos de uso ayudan a supervisar la operación, pero no garantizan cargos ni capacidad futuros.
- Compare el uso de la plataforma con los registros de solicitudes de la aplicación.
- Rote las credenciales expuestas y compruebe las nuevas.
- Revoque las claves que ya no use y revise periódicamente los accesos.
Preguntas frecuentes
¿La inferencia y el entrenamiento de modelos usan la misma API?
No. Son productos distintos y tienen procesos documentados diferentes. Use la referencia de la capacidad que necesite.
¿Dónde encuentro el contrato de API compatible?
Consulte la documentación del producto y la referencia OpenAPI enlazadas en esta guía. Describen la interfaz publicada actualmente.
¿Dónde debo guardar un secreto de API?
Use un gestor seguro de secretos del lado del servidor. No lo incluya en un repositorio, código de navegador ni registros.
¿Qué hago si se expone una clave?
Rótela o revóquela en Claves de API, sustitúyala en el almacén de secretos de la aplicación y revise si hay actividad reciente inesperada.