Reloadly SDK for Node.JS

The Reloadly SDK for Node.JS enables developers to easily work with Reloadly Services and build scalable solutions. You can get started in minutes using npm.

• SDK Homepage (Coming soon)
• Sample Code
• API Docs
• Issues
• Giving Feedback
• Getting Help

Getting Started

Sign up for Reloadly

Before you begin, you need a Reloadly account. Please see the Sign Up for Reloadly section of the knowledge-base for information about how to create a Reloadly account and retrieve your Reloadly APIs credentials.

Minimum Requirements

To run the SDK you will need Node.js v14 or higher.

Using the SDK Modules

The SDK is made up of several modules such as Authentication, Airtime, etc..., you can alternatively add dependencies for the specific services you use only. For example : Authentication & Airtime (currently all modules have the same version, but this may not always be the case)

Add specific dependencies to your project's build file:

npm install @reloadly/reloadly.airtime
npm install @reloadly/reloadly.authentication

Getting Help

GitHub issues is the preferred channel to interact with our team. Also check these community resources for getting help:

• Checkout & search our knowledge-base
• Talk to us live on our chat tool on our website (bottom right)
• Ask a question on StackOverflow and tag it with reloadly-nodejs-sdk
• Articulate your feature request or upvote existing ones on our Issues page
• Take a look at our youtube series for plenty of helpful walkthroughs and tips
• Open a case via with the Reloadly Support Center
• If it turns out that you may have found a bug, please open an issue

Documentation

Please see:

• The Usage and Sample Code page for code reference including how to set up, customize and use the SDK.
• The API docs for the most up-to-date API documentation.
• The example web application for a reference implementation.

Giving Feedback

We need your help in making this SDK great. Please participate in the community and contribute to this effort by submitting issues, participating in discussion forums and submitting pull requests through the following channels:

• Submit issues - this is the preferred channel to interact with our team
• Come join the Reloadly Node.js community chat on Gitter
• Articulate your feature request or upvote existing ones on our Issues page
• Send feedback directly to the team at oss@reloadly.com

License

This project is licensed under the MIT license. See the LICENSE file for more info.