AuroisecureX SDK

A monitoring tool for registering your application in AuroisecureX and activating the NPM package using an activation key.

Installation

To install the AuroisecureX SDK, run the following command:

npm install auroisecurex-sdk

Setup

1. Register Your App in AuroisecureX:

   • Go to the AuroisecureX platform and register your application to generate an Activation Key.
   • Ensure you have the necessary credentials and permissions to perform this registration.

2. Activate SDK:

   • Once you have the Activation Key, you need to activate the SDK within your application.

3. Use the SDK: Import and initialize the SDK in your project:

   import AuroisecureX from 'auroisecurex-sdk';
   
   const auroisecureX = new AuroisecureX({
     activationKey: 'YOUR_ACTIVATION_KEY'
   });
   
   // Use the SDK's methods for monitoring
   auroisecureX.startMonitoring();

Features

• Monitoring: Monitors the health and performance of your application.
• Easy Registration: Register your app with AuroisecureX for instant access to monitoring features.
• Activation Key: Use an activation key to enable SDK features.

API

AuroisecureX

The primary class for interacting with the AuroisecureX SDK.

Constructor

new AuroisecureX({ activationKey: string })

• activationKey: The unique activation key generated after registering your app.

Methods

• startMonitoring(): Starts the monitoring process.

  auroisecureX.startMonitoring();

• stopMonitoring(): Stops the monitoring process.

  auroisecureX.stopMonitoring();

Configuration

The SDK accepts the following configuration options:

• activationKey: Required. The key obtained after registering your app in AuroisecureX.

Example Usage

import AuroisecureX from 'auroisecurex-sdk';

const auroisecureX = new AuroisecureX({
  activationKey: 'YOUR_ACTIVATION_KEY'
});

auroisecureX.startMonitoring();

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Feel free to open issues or pull requests if you want to contribute or report bugs. Please follow the guidelines for submitting issues and contributing to the repository.

Contact

For support or inquiries, reach us at [email protected].