Skip to main content

Referenca za REST API

Osnovna konfiguracija​

Osnovni URL: {site_url}/wp-json/wu/v2/ Autentikacija: API ključ i tajna (HTTP Basic Auth ili URL parametri)

Autentikacija​

Omogući API​

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

Dohvati API vjerodajnice​

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

Metode autentikacije​

HTTP Basic Auth (preporučeno):

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

URL parametri:

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

Glavne krajnje točke​

1. API za korisnike​

Osnovna ruta: /customers

Dohvati sve korisnike

GET /wu/v2/customers

Dohvati jednog korisnika

GET /wu/v2/customers/{id}

Stvori korisnika

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

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

Ažuriraj korisnika

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

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

Izbriši korisnika

DELETE /wu/v2/customers/{id}

2. API za web-mjesta​

Osnovna ruta: /sites

Stvori web-mjesto

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 za članstva​

Osnovna ruta: /memberships

Stvori članstvo

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 za proizvode​

Osnovna ruta: /products

Dohvati sve proizvode

GET /wu/v2/products

5. API za plaćanja​

Osnovna ruta: /payments

Stvori plaćanje

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 za domene​

Osnovna ruta: /domains

Mapiraj domenu

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

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

Krajnja točka za registraciju​

Krajnja točka /register pruža potpuni tijek naplate/registracije:

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

Odgovor:

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

Krajnje točke za suverene tenante​

Ultimate Multisite: Multi-Tenancy 1.2.0 dodaje REST pokrivenost za suverene tenante za integracije koje pripremaju, pregledavaju ili provjeravaju izolirane tenante.

Točno opterećenje zahtjeva ovisi o omogućenoj sposobnosti hosta, ali integracije bi trebale očekivati ove skupine krajnjih točaka:

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}

Upotrijebite krajnju točku bootstrap za pripremu registra tenanta, baze podataka, datotečnog sustava i stanja usmjeravanja. Upotrijebite krajnje točke statusa migracije i provjere prije prebacivanja produkcijskog prometa. Upotrijebite krajnju točku za brisanje za suvereno uklanjanje kako bi se vjerodajnice baze podataka uklonile kroz tijek čišćenja dodatka.

Tipični odgovori statusa migracije uključuju:

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

Tretirajte ready: false kao blokator prije pokretanja. Provjerite pojedinosti provjere, ispravite povezivanje hosta baze podataka, red čekanja, pripremu korisnika ili problem s usmjeravanjem, zatim ponovno pokušajte provjeru.

Odgovori o pogreškama​

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

Paginacija i filtriranje​

Parametri upita:

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

Uobičajeni parametri:

  • per_page - Stavke po stranici (zadano: 20, maks.: 100)
  • page - Broj stranice
  • search - Pojam za pretraživanje
  • orderby - Polje za sortiranje
  • order - Smjer sortiranja (asc/desc)
  • status - Filtriraj prema statusu
  • date_created - Filtriraj prema rasponu datuma