Render9 OTP

Render9 OTP is a lightweight and easy-to-use npm package for sending OTP (One-Time Password) messages via the Render9 OTP API. This package is ideal for developers looking to integrate OTP functionality into their Node.js applications with minimal setup.

Installation

You can install Render9 OTP using npm:

npm install render9

Usage

To start using Render9 OTP, you'll need to add your Render9 API key to your environment variables.

Setup Environment Variables

Add your Render9 API key to your .env file:

RENDER9_API_KEY=your_render9_api_key_here

Make sure to add the .env file to your .gitignore to avoid exposing your API key in version control.

Basic Example

Here's an example of how to send an OTP using Render9 OTP:

import { sendOtp } from "render9";
import dotenv from "dotenv";

dotenv.config(); // Load environment variables from .env file

const runExample = async () => {
  const result = await sendOtp({
    phoneNumber: "1234567890",
    countryCode: "+91",
    otp: "123456",
  });

  console.log(result);
};

runExample();

API Reference

sendOtp(payload: SendOtpInterface): Promise<{ error: boolean; message: string }>

Parameters:

• phoneNumber (string): The recipient's phone number.
• countryCode (string): The recipient's country code (e.g., '+91').
• otp (string): The OTP to be sent.
• apiKey (string): Your Render9 API key. If not provided, the package will use the value from process.env.RENDER9_OTP_KEY.

Returns:

• A Promise that resolves to an object containing:
  • error (boolean): Indicates if there was an error.
  • message (string): A message describing the result.

Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub if you have any suggestions or improvements.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

This version reflects the correct package name, "Render9 OTP," throughout the README.md file.