IssueBadge Certificate Generator for Redmine

A Redmine plugin that integrates with IssueBadge.com to issue digital certificates and badges to your users directly from Redmine.

Features

• API Integration: Seamlessly connect to IssueBadge.com using your API key
• Badge Management: Sync and manage badge templates from your IssueBadge account
• Easy Badge Issuance: Issue certificates to recipients with a simple form
• Issued Badge Tracking: View all issued badges with detailed history
• Certificate Viewing: Direct links to view and share certificates
• User-Friendly Interface: Integrated admin menu with intuitive navigation

Requirements

• Redmine 4.0 or higher
• Ruby 2.5 or higher
• An active IssueBadge.com account with API access

Installation

1. Download the plugin:

   cd /path/to/redmine/plugins
   git clone https://github.com/yourusername/redmine_issuebadge.git

2. Install dependencies:

   cd /path/to/redmine
   bundle install

3. Run database migrations:

   bundle exec rake redmine:plugins:migrate RAILS_ENV=production

4. Restart Redmine:

   # For Passenger
   touch tmp/restart.txt
   
   # For systemd service
   sudo systemctl restart redmine

5. Access the plugin:

   • Log in to Redmine as an administrator
   • Navigate to Administration → IssueBadge Settings

Configuration

Step 1: Get Your API Key

1. Sign up or log in at IssueBadge.com
2. Navigate to your account settings
3. Copy your API key

Step 2: Configure the Plugin

1. In Redmine, go to Administration → IssueBadge Settings
2. Enter your IssueBadge API key
3. Click Test Connection to verify your credentials
4. Click Save to store your settings

Step 3: Sync Badge Templates

1. Navigate to Administration → Badge Templates
2. Click Sync Badges to fetch your templates from IssueBadge
3. Your available badge templates will appear in the list

Usage

Issuing a Badge

1. Navigate to Administration → Badge Templates or Issued Badges
2. Click Issue New Badge (or click Issue Badge next to a specific template)
3. Fill in the form:
   • Badge Template: Select the badge/certificate template
   • Recipient Name: Enter the recipient's full name
   • Recipient Email: (Optional) Enter email for notification
4. Click Issue Badge

Viewing Issued Badges

1. Navigate to Administration → Issued Badges
2. View the complete history of all issued certificates
3. Click on a badge name to see detailed information
4. Use View Certificate to open the public certificate URL

Deleting an Issued Badge

1. Navigate to Administration → Issued Badges
2. Click the delete icon next to the badge you want to remove
3. Confirm the deletion

API Integration

The plugin integrates with the following IssueBadge API endpoints:

• POST /validate-key - Validates API credentials
• GET /badge/getall - Fetches all badge templates
• POST /issue/create - Issues a new certificate

All API requests use Bearer token authentication with your API key.

Database Schema

The plugin creates one table:

issuebadge_issues

• id - Primary key
• badge_id - IssueBadge template ID
• badge_name - Badge template name
• issue_id - Unique issue ID from IssueBadge
• recipient_name - Recipient's name
• recipient_email - Recipient's email (optional)
• public_url - Public certificate URL
• user_id - Redmine user who issued the badge
• created_at - Timestamp of issuance
• updated_at - Last update timestamp

Permissions

The plugin adds the following permissions (configurable in Administration → Roles and permissions):

• View issued badges - View the list of issued badges
• Issue badges - Issue new badges to recipients
• Manage IssueBadge settings - Access and modify plugin settings

Troubleshooting

Connection Test Fails

Problem: "Connection test failed: Unauthorized"

• Solution: Verify your API key is correct and active

Problem: "Connection test failed: Connection timeout"

• Solution: Check your firewall settings and ensure Redmine can make outbound HTTPS requests

Badges Not Syncing

Problem: No badges appear after clicking "Sync Badges"

• Solution: Ensure you have created badge templates in your IssueBadge account first

Migration Errors

Problem: Database migration fails

• Solution: Check database permissions and ensure the Redmine database user has CREATE TABLE privileges

Uninstallation

1. Rollback database migrations:

   cd /path/to/redmine
   bundle exec rake redmine:plugins:migrate NAME=redmine_issuebadge VERSION=0 RAILS_ENV=production

2. Remove plugin directory:

   rm -rf plugins/redmine_issuebadge

3. Restart Redmine:

   touch tmp/restart.txt

Support

For issues related to:

• The plugin: Open an issue on GitHub
• IssueBadge API: Contact IssueBadge support
• Redmine: Visit Redmine.org

License

This plugin is released under the MIT License.

Credits

Developed for integration with IssueBadge.com - Digital Certificate and Badge Issuance Platform

Changelog

Version 1.0.0 (2025-10-23)

• Initial release
• API integration with IssueBadge.com
• Badge template synchronization
• Badge issuance functionality
• Issued badges tracking and management
• Admin interface with settings, templates, and issuance forms