API Keys

Una clave API es una cadena cifrada simple que puede utilizar al llamar a las API de LogicalDOC.

Cada usuario puede generar varias claves API, y cada una de ellas puede ser utilizada por una aplicación externa para conectarse a LogicalDOC en nombre de ese usuario. Esto es más seguro en comparación con el uso directo de las credenciales del usuario y, desde la versión 9.0, la autenticación de credenciales heredadas ha quedado obsoleta en favor de la nueva autenticación de clave API.

Crear una API key

Open the menu Cuenta > Seguridad > API Keys.

Aquí haga clic en Crear nueva API key. Se le pedirá que le dé un nombre a la nueva clave, así que escriba el nombre y confirme.

Copia inmediatamente el código en un lugar seguro porque no podrás volver a verlo.

Luego puedes colocar esta clave generada en tu aplicación para que pueda conectarse a LogicalDOC.

Cómo proteger una API key

Cuando utilice claves API en sus aplicaciones, asegúrese de que se mantengan seguras durante el almacenamiento y la transmisión. Si expone sus credenciales públicamente, su cuenta puede verse comprometida, lo que podría generar cargos inesperados en su cuenta. Para ayudar a mantener seguras sus claves API, siga estas prácticas recomendadas:

No incorpore claves API directamente en el código. Las claves API que están incorporadas en el código pueden exponerse al público accidentalmente. Por ejemplo, puede olvidar eliminar las claves del código que comparte. En lugar de incorporar sus claves API en sus aplicaciones, almacénelas en variables de entorno o en archivos fuera del árbol de origen de su aplicación.

No comparta la misma clave API entre varias aplicaciones; por ejemplo, no utilice la misma clave para los complementos de Office, sino que cree una clave API para el complemento de Office y una clave diferente para el complemento de Outlook.

Elimine las claves API innecesarias para minimizar la exposición a ataques.

Revise su código antes de publicarlo. Asegúrese de que su código no contenga claves API ni ninguna otra información privada antes de ponerlo a disposición del público.