IssueBadge API

Comprehensive badge management and issuance platform

🚀 Welcome to IssueBadge API

IssueBadge provides a powerful REST API for managing digital badges and certificates. Our multi-tenant platform supports badge creation, issuance, and verification with advanced customization options.

⚡ Quick Start

Get started with IssueBadge API in minutes:

# 1. Get your API key from dashboard
# 2. Validate your key
curl -X POST "https://app.issuebadge.com/api/v1/validate-key" \
    -H "Content-Type: application/json" \
    -d '{"api_key": "your_api_key_here"}'

# 3. Create your first badge
curl -X POST "https://app.issuebadge.com/api/v1/badge/create" \
    -H "Authorization: Bearer your_token" \
    -F "name=Web Development Certificate" \
    -F "description=Awarded for course completion" \
    -F "issuing_organization_name=Your Organization" \
    -F "idempotency_key=unique_key_123"

🔐 Dual Authentication

Support for both personal access tokens and OAuth2 bearer tokens for flexible integration.

🏢 Multi-Tenant Architecture

Complete tenant isolation ensures your data remains secure and separate from other organizations.

🎨 Custom Fields

Define custom fields for badges to capture specific information like completion dates, scores, or certifications.

🔄 Idempotency Protection

Prevent duplicate operations with idempotency keys, ensuring data integrity across all operations.

📧 Automated Notifications

Automatic email notifications to badge recipients with verification URLs and certificate details.

🌐 Public Verification

Each issued badge comes with a public verification URL for authenticity checking.

🔑 Authentication Methods

API Key Authentication

Personal access tokens for direct API access

Authorization: Bearer 1|token...

OAuth2

Bearer tokens for third-party integrations

Authorization: Bearer oauth_token...

📋 API Endpoints Overview

POST

/validate-key

Validate API authentication tokens

GET

/badge/getall

Retrieve all available badges

POST

/badge/create

Create new badge templates

POST

/issue/create

Issue badges to recipients

🔧 MCP Server Integration

Use our Model Context Protocol (MCP) server to integrate IssueBadge with AI assistants:

# Install MCP server
cd mcp-server
npm install
npm run build

# Configure with Claude Desktop
{
  "mcpServers": {
    "issuebadge": {
      "command": "node",
      "args": ["/path/to/mcp-server/dist/index.js"]
    }
  }
}