REST API: ügyfelek útvonal

A customers útvonallal az ügyfelek adatbázisát éred el: lekérdezheted, létrehozhatod, módosíthatod és törölheted az ügyfeleket. Az útvonal csak akkor érhető el, ha a Restrict Content Pro 3.0 vagy újabb van telepítve.

Ügyfelek lekérése

GET /wp-json/rcp/{verzió}/customers/

Kötelező paraméter nincs. Választható paraméterek:

Paraméter	Típus	Jelentés
user_id	egész	Szűrés felhasználóazonosítóra.
email_verification	szöveg	Szűrés az e-mail-megerősítés állapotára: verified, pending, none.
count	logikai	Igaz esetén csak az ügyfelek számát adja vissza, hamis esetén az ügyfélobjektumok tömbjét. Alapérték: hamis.
number	egész	A találatok legnagyobb száma.
offset	egész	Ennyi ügyfelet ugrik át (lapozáshoz). Alapérték: 0.
search	szöveg	Keresőkifejezés.

Egy ügyfél lekérése

GET /wp-json/rcp/{verzió}/customers/{ügyfél_id}

A következők egyike kötelező:

• id: az ügyfél azonosítója (az URL-ben vagy a kérés törzsében).
• user_email: az ügyfél e-mail-címe.
• user_login: az ügyfél felhasználóneve.

A user_email és a user_login paraméterhez az API 1.2 vagy újabb verziója kell.

Új ügyfél

POST /wp-json/rcp/{verzió}/customers/new

Kötelező: user_id (egész), a hozzá tartozó felhasználói fiók azonosítója.

Választható paraméterek:

Paraméter	Jelentés
has_trialed	Használt-e már ingyenes próbaidőszakot: 0, ha még nem, 1, ha igen. Alapérték: 0.
date_registered	A regisztráció ideje MySQL-formátumban. Alapérték: a mai nap.
email_verification	Az e-mail-megerősítés állapota: verified, pending, none.
last_login	Az utolsó bejelentkezés ideje MySQL-formátumban.

Ügyfél módosítása

POST /wp-json/rcp/{verzió}/customers/update/{ügyfél_id}

Kötelező: id (egész), a módosítandó ügyfél azonosítója (az URL-ben vagy a törzsben). Választható: has_trialed, user_id, date_registered, email_verification, last_login, jelentésük megegyezik az új ügyfélnél leírtakkal.

Ügyfél törlése

DELETE /wp-json/rcp/{verzió}/customers/delete

Kötelező: id (egész), a törlendő ügyfél azonosítója. Választható paraméter nincs.