Home Guides Tutorials Technical
API v1.0 Stable | OpenAPI 3.1

Tài liệu kỹ thuật
& API Reference

Dành cho developers. SDKs, API endpoints, architecture diagrams, và integration guides cho UX Master platform.

RESTful API • GraphQL Support • WebSocket Real-time • Multi-language SDKs

📚 API Documentation 🚀 SDK Downloads ↓
0
API Endpoints
6
SDK Platforms
99.9%
Uptime SLA
<50ms
Latency

Quick Start

5 phút để chạy đầu tiên

Cài đặt SDK, authenticate, và gọi API đầu tiên trong vòng 5 phút.

1

Cài SDK

bash 
# Node.js
npm install @uxmaster/sdk

# Python
pip install uxmaster-sdk

# Go
go get github.com/uxmaster/sdk-go
2

Authenticate

javascript 
import { UXMaster } from '@uxmaster/sdk';

const client = new UXMaster({
  apiKey: 'uxm_live_...',
  environment: 'production'
});
3

Gọi API

javascript 
const design = await client.design.generate({
  style: 'glassmorphism',
  industry: 'fintech',
  platform: 'web'
});

console.log(design.tokens);

API Reference

RESTful API Endpoints

Complete API reference với OpenAPI 3.1 specification. Tất cả endpoints đều có versioning và backward compatibility.

POST /v1/design/generate Generate design system từ parameters
Request 
{
  "style": "glassmorphism",
  "industry": "fintech",
  "platform": "web",
  "dark_mode": true,
  "accessibility": "wcag-aaa"
}
GET /v1/ux-laws Lấy danh sách 48 UX Laws
Query Parameters 
?category=perception
?category=gestalt
?category=hicks-law
?applicable_to=mobile
Response 
{
  "laws": [
    {
      "id": "hicks-law",
      "name": "Hick's Law",
      "principle": "Decision time ↑ with options"
    }
  ]
}
POST /v1/design/validate Chạy 37 design tests trên UI
Request 
{
  "html_url": "https://example.com/page",
  "tests": ["contrast", "responsive", "a11y"],
  "device_profile": "mobile-ios"
}
GET /v1/palettes/{id} Lấy color palette theo ID
Response 
{
  "id": "violet-sunset",
  "colors": {
    "primary": "#7c3aed",
    "secondary": "#ec4899",
    "accent": "#10b981"
  },
  "tokens": { "css": "...", "scss": "..." }
}

System Architecture

Architecture & Design

Microservices architecture với event-driven design, auto-scaling, và multi-region deployment.

Clients

Web, Mobile, CLI

⚡

API Gateway

Rate Limit, Auth

Design Engine

UX Validator

💾

Storage

PostgreSQL, Redis

⚡

API Gateway

Kong + Traefik

Rate limiting, caching

🚀

Services

Node.js + Go

gRPC + REST

📊

Database

PostgreSQL 15

Read replicas

🔴

Cache

Redis Cluster

Sub-millisecond

SDKs & Integration

6 Platform SDKs

Official SDKs cho tất cả major platforms. Type-safe, fully documented, với auto-retry và error handling.

🟢

Node.js

TypeScript ready

bash 
npm install @uxmaster/sdk
✓ v2.4.0 | MIT License
🐍

Python

Async support

bash 
pip install uxmaster-sdk
✓ v1.8.2 | MIT License
🐹

Go

High performance

bash 
go get github.com/uxmaster/sdk-go
✓ v1.3.0 | MIT License
🦀

Rust

Memory safe

toml 
[dependencies]
uxmaster = "0.9.1"
✓ v0.9.1 | MIT License
🐘

PHP

Laravel ready

bash 
composer require uxmaster/sdk-php
✓ v2.1.0 | MIT License
💎

Ruby

Rails integration

ruby 
gem 'uxmaster-sdk', '~> 1.2'
✓ v1.2.5 | MIT License

Real-time Events

Webhooks & Events

Nhận real-time notifications khi design được generate, validation hoàn thành, hoặc system events.

Webhook Payload

json 
{
  "event": "design.generated",
  "timestamp": "2025-01-15T10:30:00Z",
  "data": {
    "design_id": "des_123abc",
    "status": "completed",
    "tokens_url": "https://api..."
  }
}

Event Types

design.generated
design.validated
palette.created
webhook.retrying

Open Source

GitHub & Community

UX Master là open source. Đóng góp, report issues, hoặc join discussion với cộng đồng.

⭐

Star Repository

1.2k+ stars
🐛

Report Issues

Bug reports
💬

Discussions

Q&A, Ideas
🤝

Contribute

PR welcome
1.2k
GitHub Stars
48
Contributors
150+
Commits
MIT
License
🚀

Sẵn sàng bắt đầu?

Tạo tài khoản miễn phí, lấy API key, và bắt đầu tích hợp UX Master vào ứng dụng của bạn ngay hôm nay.

📖 Xem Full Documentation 🔑 Get API Key