NebStore SDK

The NebStore SDK is a simple wrapper using Node.js that helps you interact with the NebStore API and manage your storage buckets and objects with Nebula. The NebStore SDK handles file uploads and downloads, multi-part uploads for large files, and bucket managment operations like creating, listing, emptying, and deleting.

Install the SDK

Use npm or yarn:

Install the NebStore SDK

npm install nebstore-client

Import the package

Use this snippet to import the NebStore SDK in your code:

import { NebStore } from 'nebstore-client'
const nebStore = new NebStore('{API-key}')

Replace {API-key} with your API key.

Authentication

The NebStore SDK uses bearer token authentication to communicate with the NebStore API. Your token, or API key is an encoded JSON Web Token that you must use to authenticate your requests whether you work directly with the API, or through the SDK.

Visit the Nebula console to get your API keys:

Navigate to Settings → Projects and select the project you want to work with
Copy your API key

Check out the API overview to learn more about Authentication.

Functions

The NebStore SDK offers dedicated functions to manage your storage assets. Check out these guides to learn more:

Need help?

If you have any technical questions or bump into any problems, get in touch with our Support team! We are here to help, and welcome any feedback you might have about NebStore.