Saltearse al contenido

Autenticación y claves API

Cree una clave API sk_ en el Centro de API . La clave completa se muestra solo una vez, cuando se crea o se rota.

Utilice una clave independiente para cada aplicación, entorno y tarea automatizada, de modo que cada uno pueda tener su propio presupuesto y ser deshabilitado, rotado y auditado por separado.

Recomendado:

X-API-Key: sk_your_key

La forma estándar Bearer también funciona:

Authorization: Bearer sk_your_key

Envíe solo uno de los dos en una solicitud.

Ventana de terminal
curl https://omnidoc.top/api/v1/jobs \
-H "X-API-Key: $OMNIDOC_API_KEY"

Una clave opera en nombre de la cuenta que la creó: puede invocar los servicios que dicha cuenta puede utilizar y acceder únicamente a los recursos de esa cuenta. Una clave no puede modificar el correo electrónico de inicio de sesión, la contraseña, el número de teléfono ni el perfil, y tampoco puede crear, rotar ni revocar claves API.

Límites opcionales:

  • allowed_engines: solo los ajustes de traducción enumerados; un array vacío no añade ningún límite a nivel de clave.
  • expires_at: hora de expiración.
  • quota_limit: el presupuesto de vida útil de la clave en milicréditos enteros; 0 no establece ningún presupuesto a nivel de clave, y los créditos de la cuenta se liquidan como de costumbre.

Cree claves, modifique sus límites, rotéelas o revóquelas en el centro de la API . Una vez que una clave es revocada, deshabilitada o caducada, o cuando su cuenta está deshabilitada, las nuevas solicitudes fallan de inmediato.

La rotación crea un nuevo secreto y deshabilita el anterior de inmediato; la nueva clave mantiene los límites originales y el presupuesto ya utilizado. Una clave caducada no puede ser rotada; cree una nueva. Para realizar el cambio sin problemas, cree una nueva clave y desplieguela, confirme que las llamadas tengan éxito y luego revoque la clave antigua.

  • Mantenga las claves únicamente en el servidor o en un entorno de ejecución controlado.
  • Utilice variables de entorno o un gestor de secretos; nunca incluya claves en el código fuente, los registros, los paquetes del navegador ni en repositorios públicos.
  • Nunca envíe la clave a las direcciones de carga o descarga devueltas por la API.
  • Registre el ID de la clave, el ID de la solicitud y el ID de la operación; nunca registre la clave completa.
  • Si una clave se filtra, revóltela de inmediato y revise sus tareas y cargos.