REST API: áttekintés

A Restrict Content Pro REST API bővítménye teljes JSON-alapú REST API-t ad a tagsági adatok lekérdezéséhez, létrehozásához, módosításához és törléséhez. A bővítményt külön kell telepíteni és licencelni, a Restrict Content Pro alapbővítmény önmagában nem tartalmazza.

Végpont

Az API a /wp-json/rcp/ címen érhető el. Ha a WordPress alapértelmezett wp-json előtagját megváltoztattad, az rcp végpont követi a módosítást, vagyis az új előtaggal kell hívnod.

Verziózás

Az API minden önálló verziója az rcp végponton belül külön útvonalon érhető el:

/wp-json/rcp/{verzió}/{útvonal}

Például: /wp-json/rcp/v1/{útvonal}. A jelenlegi API-verzió a v1.

• Egy verziót bármikor elavultnak lehet nyilvánítani, de törést okozó változtatás csak új verziószámmal kerül be.
• A korábbi verziókat várhatóan legalább hat hónapig elérhetően tartják az újabb megjelenése után.

Hitelesítés

A kérésekhez egy WordPress-felhasználói fiókkal kell hitelesítened magad, és a fióknak rendelkeznie kell a megtekintéshez, módosításhoz és törléshez szükséges jogosultságokkal. A hitelesítés módját (például alkalmazásjelszó vagy sütialapú hitelesítés) a WordPress REST API szokásos szabályai adják.

Útvonalak

Útvonal	Mire való	Fejezet
customers	Ügyfelek	Ügyfelek útvonal
memberships	Tagságok	Tagságok útvonal
levels	Tagsági szintek	Szintek és bevétel
earnings	Bevételi összesítők	Szintek és bevétel
payments	Fizetések	Fizetések útvonal
members	Tagok (elavult)	Tagok útvonal