Hoppa yfir á aðal efni

REST API tilvísun

Grunnstillingar​

Grunn-URL: {site_url}/wp-json/wu/v2/ Auðkenning: API-lykill og leyndarmál (HTTP Basic Auth eða URL-færibreytur)

Auðkenning​

Virkja API​

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

Sækja API-auðkenni​

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

Auðkenningaraðferðir​

HTTP Basic Auth (mælt með):

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

URL-færibreytur:

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

Kjarnaendapunktar​

1. Viðskiptavina-API​

Grunnleið: /customers

Sækja alla viðskiptavini

GET /wu/v2/customers

Sækja einn viðskiptavin

GET /wu/v2/customers/{id}

Búa til viðskiptavin

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

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

Uppfæra viðskiptavin

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

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

Eyða viðskiptavin

DELETE /wu/v2/customers/{id}

2. Vefja-API​

Grunnleið: /sites

Búa til vef

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. Aðildar-API​

Grunnleið: /memberships

Búa til aðild

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. Vöru-API​

Grunnleið: /products

Sækja allar vörur

GET /wu/v2/products

5. Greiðslu-API​

Grunnleið: /payments

Búa til greiðslu

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. Léna-API​

Grunnleið: /domains

Tengja lén

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

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

Skráningarendapunktur​

Endapunkturinn /register veitir heilt checkout-/skráningarflæði:

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

Endapunktar fyrir fullvalda leigjendur​

Ultimate Multisite: Multi-Tenancy 1.2.0 bætir við REST-umfjöllun um fullvalda leigjendur fyrir samþættingar sem útvega, skoða eða staðfesta einangraða leigjendur.

Nákvæmt beiðniinnihald fer eftir virkjuðum eiginleika hýsilsins, en samþættingar ættu að búast við þessum endapunktahópum:

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}

Notaðu bootstrap-endapunktinn til að undirbúa skrá leigjanda, gagnagrunn, skráakerfi og stöðu leiðar. Notaðu endapunkta fyrir flutningsstöðu og staðfestingu áður en framleiðsluumferð er færð yfir. Notaðu eyðingarendapunktinn fyrir fullvalda niðurrif svo gagnagrunnsauðkenni séu fjarlægð í gegnum hreinsunarflæði viðbótarinnar.

Dæmigerð svör um flutningsstöðu innihalda:

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

Líttu á ready: false sem hindrun fyrir ræsingu. Athugaðu staðfestingarupplýsingarnar, lagaðu bindingu gagnagrunnshýsils, biðröð, útvegun notenda eða leiðarvandamál og reyndu síðan staðfestingu aftur.

Villusvör​

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

Síðuskipting og síun​

Fyrirspurnarfæribreytur:

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

Algengar færibreytur:

  • per_page - Atriði á hverri síðu (sjálfgefið: 20, hámark: 100)
  • page - Síðunúmer
  • search - Leitarorð
  • orderby - Röðunarsvið
  • order - Röðunarstefna (asc/desc)
  • status - Sía eftir stöðu
  • date_created - Sía eftir dagsetningarbili