The IronWeb SDK is available on NPM under the package name @ironcorelabs/ironweb. This module includes the SDK in both ES6 Module and CommonJS format as well as a single minified
ironweb.min.js. It can be installed via either NPM or Yarn.
npm install @ironcorelabs/ironweb
yarn add @ironcorelabs/ironweb
You can also view the source of the SDK via its GitHub repository.
Use the IronWeb SDK as a standalone script that creates a global
ironwebvariable that encapsulates all functionality. To import IronWeb as a standalone script use a resource such as Unpkg.
The IronWeb SDK methods are grouped into namespaces to separate functionality.
|SDK Initialization and Unauthenticated User Management||Initialize the IronWeb SDK as a authenticated user or manage unauthenticated users.|
|Document||Create, update, and manage access to your encrypted content.|
|Group||Create and manage members and admins of your cryptographic groups.|
|User||Manage the currently authenticated user of the SDK.|
|Search||Create and manage encrypted blind search indexes.|
|Codec||Utility methods to handle data conversion between different formats.|
Most IronWeb SDK methods return a Promise. If an SDK operation fails the Promise that was created will reject with a SDKError that provides additional information about the error that occurred. Each
SDKErrorhas a specific error code that exposes information about the error that occurred.
The IronWeb SDK works on the latest versions of Chrome, Firefox, Safari, and Edge.