What is the Spaceship Registrar Module for WHMCS?

The Spaceship Registrar Module integrates the Spaceship API into WHMCS, allowing seamless domain registration, transfer, and renewal functionalities.

Is the Spaceship Registrar Module free to use?

The module is free to use but is a test project created for personal and educational purposes. It may contain bugs or security vulnerabilities.

How do I install the Spaceship Registrar Module?

To install the module, extract the files, upload the 'spaceship' folder to the 'modules/registrars/' directory, and then activate it in the WHMCS Admin Panel.

What version of WHMCS is required?

The Spaceship Registrar Module requires WHMCS version 8.x or higher.

What are the system requirements for using the module?

The module requires PHP 7.4 or higher and valid Spaceship API credentials.

Can I customize the templates for the Spaceship Registrar Module?

Yes, you can modify the templates in the 'templates/' directory, including 'domain.tpl' and 'error.tpl'.

Where can I find the API request and response logs?

API logs are stored in the 'logs/api.log' file for debugging purposes.

How can I configure my Spaceship API credentials?

You can configure your API credentials by editing the 'config.json' file with your Spaceship API key and secret.

Can I use this module with any domain registrar?

No, this module specifically integrates with the Spaceship API for domain registration, transfer, and renewal.

Does the Spaceship Registrar Module support domain renewals?

Yes, the module automates the domain renewal process.

Is the Spaceship Registrar Module compatible with all WHMCS themes?

Yes, the module should be compatible with most WHMCS themes, but you may need to adjust the templates for custom themes.

Can I change the language for the module?

Yes, you can modify language strings by editing the 'lang/english.php' file or adding a new language file.

What happens if I encounter an error while using the module?

If an error occurs, you can check the 'logs/api.log' file for detailed information and troubleshoot accordingly.

What is the license for the Spaceship Registrar Module?

The module is licensed under the MIT License.

How do I contact the developer for support?

You can reach the developer by email at springmusk@gmail.com or visit their website at [Basanta Sapkota](https://basantasapkota026.com.np).

Can I use the module for multiple domains?

Yes, you can use the module to manage multiple domains through your WHMCS installation.

Does the Spaceship Registrar Module support domain transfers?

Yes, the module supports domain transfers from other registrars to Spaceship.

Can I test the module before using it in production?

Yes, you can test the module in a staging environment before deploying it to production.

Spaceship Registrar Module for WHMCS

Managing domains can be a hassle for hosting providers and resellers, especially when dealing with domain registration, transfers, and renewals. The Spaceship Registrar Module for WHMCS is a powerful tool designed to simplify this process by integrating the Spaceship API directly into WHMCS. In this blog post, we'll dive into the features, installation process, and configuration steps to get you started with this module.

🚀 Overview of the Spaceship Registrar Module

The Spaceship Registrar Module allows seamless management of domains from within the WHMCS platform. It includes key features such as domain registration, transfer, and renewal. The module is designed with hosting providers in mind, making it easier to manage multiple domains through an intuitive interface.

Explore the Project

Check out the full source code and contribute to the project on GitHub:

View on GitHub

⚠️ Disclaimer

Please note that this module is a test project created for educational and personal use. It is not officially endorsed by the Spaceship company. The module may contain bugs or security vulnerabilities, so use it at your own risk. No guarantees or support are provided for this module, so ensure thorough testing before deploying it in a live environment.

🌟 Key Features

Domain Registration: Register new domains directly from your WHMCS installation.
Domain Transfer: Effortlessly transfer domains between registrars.
Domain Renewal: Automate domain renewal to ensure uninterrupted service.
Customizable Templates: Adjust domain and error templates to match your branding.
Error Handling: Built-in error logging to help you troubleshoot easily.

🔧 Installation Instructions

Setting up the Spaceship Registrar Module is simple. Just follow these steps:

Extract and Upload:
- Extract the module files and upload the spaceship folder to the modules/registrars/ directory of your WHMCS installation.
Activate the Module:
- Log into your WHMCS Admin Panel.
- Go to Setup > Products/Services > Domain Registrars.
- Activate the "Spaceship" module.
Configure API Credentials:
- Open the config.json file in the module directory.
- Enter your Spaceship API key and secret.

⚙️ Configuration Steps

API Setup:
- In the config.json file, add your Spaceship API key and secret to authenticate your requests.
Language Customization:
- Modify language strings in lang/english.php to customize the module’s text according to your preferred language or branding.
Template Customization:
- Update templates/domain.tpl and templates/error.tpl to tailor the domain-related UI and error handling pages.

🧰 File Structure

Here’s a quick overview of the module's file structure:

spaceship/
├── lang/
│   └── english.php       # Language strings
├── lib/
│   ├── SpaceshipAPI.php  # API handler
│   ├── Utils.php         # Utility functions
├── logs/
│   └── api.log           # API request logs
├── templates/
│   ├── domain.tpl        # Domain task template
│   └── error.tpl         # Error page template
├── config.json           # API credentials
├── logo.png              # Module logo
├── spaceship.php         # Main module script
└── README.md             # Documentation

📝 Development Insights

Main Module Script: The spaceship.php file serves as the heart of the module, orchestrating the interactions between WHMCS and the Spaceship API.
API Handling: The lib/SpaceshipAPI.php file manages all API requests and responses.
Utility Functions: Reusable helper functions are housed in lib/Utils.php, streamlining module functionality.

🛠️ Requirements

WHMCS Version: 8.x or higher.
PHP Version: 7.4 or higher.
Valid Spaceship API credentials.

🐞 Troubleshooting

If you run into any issues, here are a few troubleshooting tips:

API Errors: Check the logs/api.log file for detailed error messages. Make sure your API credentials in config.json are accurate.
Template Issues: Ensure that the syntax in domain.tpl or error.tpl is correct. Clear your WHMCS template cache if changes aren’t visible.
Language Support: For additional language support, create a new file in the lang/ directory and update your module settings.

🤝 Contributing

This module is open for contributions! If you’d like to enhance its features or fix bugs, feel free to fork the repository, make your changes, and submit a pull request.

📝 License

This project is licensed under the MIT License. For more details, please refer to the LICENSE file.

📞 Contact

For any inquiries or support requests, you can reach out via:

Email: springmusk@gmail.com
Website: Basanta Sapkota

By implementing the Spaceship Registrar Module in your WHMCS installation, you can streamline domain management and improve your hosting or reseller operations. Happy domain managing!

Basanta Sapkota