Overview - Mun design

MunDesign Public API Overview

Giới thiệu

MunDesign Public API là một RESTful API được thiết kế để cung cấp quyền truy cập vào hệ thống quản lý đơn hàng thiết kế.
API này cho phép các ứng dụng bên thứ ba tích hợp và tương tác với hệ thống MunDesign một cách an toàn và hiệu quả.

Thông tin cơ bản

Base URL: https://develop.munpod.design

Authentication

API sử dụng API Key authentication. Tất cả các request phải bao gồm header:
X-API-Key: your-api-key-here

Response Format

Tất cả responses đều trả về dạng JSON với cấu trúc:
{
"success": true/false,
"data": {...},
"message": "Mô tả kết quả",
"error": "Chi tiết lỗi (nếu có)"
}

Tính năng chính

Orders Management

Create Order: Tạo đơn hàng mới

Get Orders: Lấy danh sách đơn hàng với filters và pagination

Get Order by ID: Lấy chi tiết một đơn hàng

Update Order: Cập nhật thông tin đơn hàng

Delete Order: Xóa đơn hàng

Webhook System

Nhận thông báo real-time khi có sự kiện quan trọng

Hỗ trợ các events:

order.created: Khi đơn hàng mới được tạo

order.updated: Khi đơn hàng được cập nhật

order.completed: Khi đơn hàng hoàn thành

HMAC-SHA256 signature verification để đảm bảo tính xác thực

API Key Management

Tạo và quản lý API keys

Cấu hình permissions cho từng key

Theo dõi usage statistics

Quick Start

Lấy API Key

Liên hệ admin để được cấp API key hoặc tạo từ dashboard

Test Connection

curl -X GET http://localhost:8001/api/v1/orders
-H "X-API-Key: your-api-key-here"

Create First Order

curl -X POST http://localhost:8001/api/v1/orders
-H "X-API-Key: your-api-key-here"
-H "Content-Type: application/json"
-d '{
"title": "Logo Design",
"description": "Modern logo for tech startup",
"customer_email": "customer@example.com"
}'

Rate Limiting

Default: 1000 requests/hour per API key

Burst: 100 requests/minute

Rate limit headers được include trong mỗi response

Error Handling

API sử dụng standard HTTP status codes:

200 OK: Request thành công

201 Created: Tạo resource thành công

400 Bad Request: Request không hợp lệ

401 Unauthorized: Thiếu hoặc sai API key

403 Forbidden: Không có quyền truy cập

404 Not Found: Resource không tồn tại

429 Too Many Requests: Vượt quá rate limit

500 Internal Server Error: Lỗi server

Webhook Integration

Cấu hình Webhook

Đăng ký webhook URL trong dashboard

Chọn events muốn subscribe

Lưu secret key để verify signatures

Verify Webhook Signature

import hmac
import hashlib

def verify_webhook(payload, signature, secret):
expected = hmac.new(
secret.encode(),
payload.encode(),
hashlib.sha256
).hexdigest()
return hmac.compare_digest(
f"sha256={expected}",
signature
)

Support

Documentation: https://docs.mundesign.com/api

Email: api-support@mundesign.com

Discord: https://discord.gg/mundesign

Changelog

v1.0.0 (2024-01): Initial release

Orders CRUD operations

Webhook system

API key authentication