Skip to main content

Tagairt REST API

Bunchumraíocht​

Base URL: {site_url}/wp-json/wu/v2/ Fíordheimhniú: API Key & Secret (HTTP Basic Auth nó Paraiméadair URL)

Fíordheimhniú​

Cumasaigh API​

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

Faigh Dintiúir API​

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

Modhanna Fíordheimhnithe​

HTTP Basic Auth (Molta):

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

Paraiméadair URL:

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

Príomhchríochphointí​

1. API Custaiméirí​

Bunbhealach: /customers

Faigh Gach Custaiméir

GET /wu/v2/customers

Faigh Custaiméir Aonair

GET /wu/v2/customers/{id}

Cruthaigh Custaiméir

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

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

Nuashonraigh Custaiméir

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

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

Scrios Custaiméir

DELETE /wu/v2/customers/{id}

2. API Suíomhanna​

Bunbhealach: /sites

Cruthaigh Suíomh

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 Ballraíochtaí​

Bunbhealach: /memberships

Cruthaigh Ballraíocht

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 Táirgí​

Bunbhealach: /products

Faigh Gach Táirge

GET /wu/v2/products

5. API Íocaíochtaí​

Bunbhealach: /payments

Cruthaigh Íocaíocht

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 Fearann​

Bunbhealach: /domains

Mapáil Fearann

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

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

Críochphointe Clárúcháin​

Soláthraíonn an críochphointe /register sreabhadh iomlán seiceála amach/clárúcháin:

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

Freagairt:

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

Críochphointí Tionóntaí Ceannasacha​

Cuireann Ultimate Multisite: Multi-Tenancy 1.2.0 clúdach REST do thionóntaí ceannasacha leis le haghaidh comhtháthuithe a dhéanann soláthar, iniúchadh, nó fíorú ar thionóntaí leithlisithe.

Braitheann an pálasta iarratais cruinn ar chumas cumasaithe an óstaigh, ach ba cheart do chomhtháthuithe a bheith ag súil leis na grúpaí críochphointí seo:

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}

Úsáid an críochphointe bootstrap chun staid chlárlann, bhunachar sonraí, chóras comhad, agus ródaithe an tionónta a ullmhú. Úsáid críochphointí stádais imirce agus fíoraithe sula n-aistrítear trácht táirgthe. Úsáid an críochphointe scriosta le haghaidh díchoimisiúnú ceannasach ionas go mbainfear dintiúir bunachair sonraí tríd an sreabhadh glanta breiseáin.

Áirítear ar ghnáthfhreagairtí stádais imirce:

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

Caith le ready: false mar bhacóir réamh-sheolta. Seiceáil sonraí an fhíoraithe, ceartaigh ceangal óstaigh an bhunachair sonraí, an ciú, soláthar úsáideora, nó fadhb ródaithe, ansin déan an fíorú arís.

Freagairtí Earráide​

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

Leathanachú agus Scagadh​

Paraiméadair Iarratais:

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

Paraiméadair choitianta:

  • per_page - Míreanna in aghaidh an leathanaigh (réamhshocrú: 20, uasmhéid: 100)
  • page - Uimhir leathanaigh
  • search - Téarma cuardaigh
  • orderby - Réimse sórtála
  • order - Treo sórtála (asc/desc)
  • status - Scag de réir stádais
  • date_created - Scag de réir raon dátaí