Hop til hovedindhold

REST API-reference

Basiskonfiguration​

Base URL: {site_url}/wp-json/wu/v2/ Godkendelse: API Key & Secret (HTTP Basic Auth eller URL-parametre)

Godkendelse​

Aktivér API​

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

Hent API-legitimationsoplysninger​

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

Godkendelsesmetoder​

HTTP Basic Auth (anbefalet):

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

URL-parametre:

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

Kerne-endpoints​

1. Kunde-API​

Basisrute: /customers

Hent alle kunder

GET /wu/v2/customers

Hent enkelt kunde

GET /wu/v2/customers/{id}

Opret kunde

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

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

Opdater kunde

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

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

Slet kunde

DELETE /wu/v2/customers/{id}

2. Sites API​

Basisrute: /sites

Opret site

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. Memberships API​

Basisrute: /memberships

Opret membership

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. Products API​

Basisrute: /products

Hent alle products

GET /wu/v2/products

5. Payments API​

Basisrute: /payments

Opret payment

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. Domains API​

Basisrute: /domains

Map domain

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

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

Registrerings-endpoint​

/register-endpointet giver et komplet checkout-/registreringsflow:

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"
    }
}

Svar:

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

Sovereign Tenant-endpoints​

Ultimate Multisite: Multi-Tenancy 1.2.0 tilføjer sovereign tenant REST-dækning til integrationer, der provisionerer, inspicerer eller verificerer isolerede tenants.

Den præcise request-payload afhænger af den aktiverede host-kapabilitet, men integrationer bør forvente disse endpoint-grupper:

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}

Brug bootstrap-endpointet til at forberede tenant-registrering, database, filsystem og routing-tilstand. Brug endpointene til migrationsstatus og verifikation, før produktionstrafik skiftes. Brug slette-endpointet til sovereign nedtagning, så database-legitimationsoplysninger fjernes gennem addon-oprydningsflowet.

Typiske svar for migrationsstatus omfatter:

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

Behandl ready: false som en blokering før lancering. Tjek verifikationsdetaljerne, ret database-host-bindingen, køen, brugerprovisioneringen eller routing-problemet, og prøv derefter verifikation igen.

Fejlsvar​

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

Paginering og filtrering​

Forespørgselsparametre:

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

Almindelige parametre:

  • per_page - Elementer pr. side (standard: 20, maks.: 100)
  • page - Sidenummer
  • search - Søgeterm
  • orderby - Sorteringsfelt
  • order - Sorteringsretning (asc/desc)
  • status - Filtrér efter status
  • date_created - Filtrér efter datointerval