REST API حوالو

بنيادي ترتيب

Base URL: {site_url}/wp-json/wu/v2/ تصديق: API Key ۽ Secret (HTTP Basic Auth يا URL Parameters)

تصديق

API فعال ڪريو

// Enable API in Ultimate Multisite settings or programmatically
wu_save_setting('enable_api', true);

API اسناد حاصل ڪريو

$api_key = wu_get_setting('api_key');
$api_secret = wu_get_setting('api_secret');

تصديق جا طريقا

HTTP Basic Auth (سفارش ڪيل):

curl -u "api_key:api_secret" https://yoursite.com/wp-json/wu/v2/customers

URL Parameters:

curl "https://yoursite.com/wp-json/wu/v2/customers?api_key=your_key&api_secret=your_secret"

بنيادي Endpoints

1. گراهڪ API

بنيادي Route: /customers

سڀ گراهڪ حاصل ڪريو

GET /wu/v2/customers

هڪ گراهڪ حاصل ڪريو

GET /wu/v2/customers/{id}

گراهڪ ٺاهيو

POST /wu/v2/customers
Content-Type: application/json

{
    "user_id": 123,
    "email_verification": "verified",
    "type": "customer",
    "has_trialed": false,
    "vip": false
}

گراهڪ اپڊيٽ ڪريو

PUT /wu/v2/customers/{id}
Content-Type: application/json

{
    "vip": true,
    "extra_information": "VIP customer notes"
}

گراهڪ حذف ڪريو

DELETE /wu/v2/customers/{id}

2. سائيٽن API

بنيادي Route: /sites

سائيٽ ٺاهيو

POST /wu/v2/sites
Content-Type: application/json

{
    "customer_id": 5,
    "membership_id": 10,
    "domain": "example.com",
    "path": "/",
    "title": "My New Site",
    "template_id": 1,
    "type": "customer_owned"
}

3. ميمبرشپن API

بنيادي Route: /memberships

ميمبرشپ ٺاهيو

POST /wu/v2/memberships
Content-Type: application/json

{
    "customer_id": 5,
    "plan_id": 3,
    "status": "active",
    "gateway": "stripe",
    "gateway_subscription_id": "sub_1234567890",
    "auto_renew": true
}

4. پروڊڪٽن API

بنيادي Route: /products

سڀ پروڊڪٽ حاصل ڪريو

GET /wu/v2/products

5. ادائيگين API

بنيادي Route: /payments

ادائيگي ٺاهيو

POST /wu/v2/payments
Content-Type: application/json

{
    "customer_id": 5,
    "membership_id": 10,
    "status": "completed",
    "gateway": "stripe",
    "gateway_payment_id": "pi_1234567890",
    "total": 29.99,
    "currency": "USD"
}

6. ڊومينن API

بنيادي Route: /domains

ڊومين Map ڪريو

POST /wu/v2/domains
Content-Type: application/json

{
    "domain": "custom-domain.com",
    "customer_id": 5,
    "primary_domain": 1,
    "stage": "domain-mapping"
}

رجسٽريشن Endpoint

/register endpoint هڪ مڪمل checkout/رجسٽريشن وهڪرو مهيا ڪري ٿو:

POST /wu/v2/register
Content-Type: application/json

{
    "customer": {
        "username": "newuser",
        "password": "securepass123",
        "email": "[email protected]"
    },
    "products": ["basic-plan"],
    "duration": 1,
    "duration_unit": "month",
    "auto_renew": true,
    "site": {
        "site_url": "mynewsite",
        "site_title": "My New Site",
        "template_id": 1
    },
    "payment": {
        "status": "completed"
    },
    "membership": {
        "status": "active"
    }
}

جواب:

{
    "customer": { ... },
    "membership": { ... },
    "payment": { ... },
    "site": { "id": 123 }
}

خودمختيار Tenant Endpoints

Ultimate Multisite: Multi-Tenancy 1.2.0 انهن انٽيگريشنز لاءِ خودمختيار tenant REST ڪوريج شامل ڪري ٿو جيڪي الڳ tenant مهيا، جاچ، يا تصديق ڪن ٿيون.

درست درخواست payload فعال ڪيل host صلاحيت تي دارومدار رکي ٿو، پر انٽيگريشنز کي انهن endpoint گروپن جي اميد رکڻ گهرجي:

POST /wu/v2/tenants/{site_id}/bootstrap
GET /wu/v2/tenants/{site_id}/migration-status
POST /wu/v2/tenants/{site_id}/verify
DELETE /wu/v2/tenants/{site_id}

tenant رجسٽري، database، filesystem، ۽ routing حالت تيار ڪرڻ لاءِ bootstrap endpoint استعمال ڪريو. production traffic مٽائڻ کان اڳ migration status ۽ verification endpoints استعمال ڪريو. خودمختيار teardown لاءِ deletion endpoint استعمال ڪريو ته جيئن database credentials addon cleanup وهڪري ذريعي هٽايا وڃن.

عام migration status جوابن ۾ شامل آهي:

{
    "site_id": 123,
    "isolation_model": "sovereign",
    "database_host": "localhost",
    "verification": {
        "no_legacy": "passed",
        "sovereign_push": "passed",
        "tenant_users": "passed"
    },
    "ready": true
}

ready: false کي pre-launch رڪاوٽ طور وٺو. verification تفصيل چيڪ ڪريو، database host binding، queue، user provisioning، يا routing مسئلو درست ڪريو، پوءِ verification ٻيهر ڪوشش ڪريو.

نقص جواب

{
    "code": "wu_rest_invalid_parameter",
    "message": "Invalid parameter value",
    "data": {
        "status": 400,
        "params": {
            "email": "Invalid email format"
        }
    }
}

صفحو بندي ۽ فلٽرنگ

Query Parameters:

GET /wu/v2/customers?per_page=20&page=2&search=john&status=active

عام parameters:

• per_page - هر صفحي تي شيون (ڊفالٽ: 20، وڌ ۾ وڌ: 100)
• page - صفحي جو نمبر
• search - ڳولا جو اصطلاح
• orderby - ترتيب ڏيڻ جو field
• order - ترتيب جي سمت (asc/desc)
• status - status موجب فلٽر ڪريو
• date_created - تاريخ جي حد موجب فلٽر ڪريو