Integration Module 2.0 for Medusa is outRead the announcement
SMSAPI logo

SMSAPI

Send SMS with optional test mode for safe messaging

npm install @yanchesky/medusa-smsapi
Built by
Regions
Service
Version
0.0.1
Last updated
1 year ago
Monthly downloads
Loading downloads

Medusa v2 SMSAPI Plugin

A notification provider plugin that enables SMS notifications via SMSAPI.com and service for Medusa v2 projects.

npm version License: MIT

Table of Contents

Features

  • SMS Notifications: Send SMS via SMSAPI.io service
  • Test Mode: Safe testing without sending actual SMS

Prerequisites

  • Medusa v2.4.0+
  • Node.js 20+
  • SMSAPI.io Account with API access token
  • Active SMS credits in your SMSAPI account

Installation

Configuration

1. Environment Variables

Create or update your file:

2. Medusa Configuration

Add the plugin to your :

Usage

Basic SMS Sending

Configuration Options

SMSAPIOptions Interface

Test Mode

Enable test mode to validate your setup without sending actual SMS. In test mode a request to API endpoint will be executed validating credentials and logging sent message.

Local Development

Contributing

All contributions are welcome! Please follow these steps:

  1. Fork the repository
  2. Create a feature branch ()
  3. Make your changes
  4. Run quality checks ()
  5. Commit your changes ()
  6. Push to the branch ()
  7. Open a Pull Request

Development Guidelines

  • Follow existing code style and conventions
  • Add TypeScript types for all new features
  • Include comprehensive error handling
  • Update documentation for new features

Support

License

MIT License


Compatibility

  • โœ… Medusa: v2.4.0+
  • โœ… Node.js: 20+
  • โœ… TypeScript: 5+
  • โœ… OPEN API: Latest API version