Flexible Subscriptions REST API

A Flexible Subscriptions REST API a WP Desk Flexible Subscriptions bővítményének kiegészítője. Az előfizetéseket külső rendszerekből is megnézheted, módosíthatod és törölheted JSON-kérésekkel.

A WooCommerce Subscriptions hivatalos REST API-jával nagyrészt kompatibilis, ezért egy meglévő integráció áttérésekor kevés módosítást igényelhet.

Mire jó

• Ha az előfizetéseket egy saját rendszerből, CRM-ből vagy automatizálásból kell lekérdezned.
• Ha az előfizetés állapotát (például aktív vagy felfüggesztett) kívülről kell váltanod.
• Ha az előfizetés eredeti és megújítási rendeléseit egy kéréssel listáznád.
• Ha előfizetéshez jegyzetet írnál vagy olvasnál API-n át.

Mit tud

Végpont	Mire való
POST /wp-json/wc/v3/orders	Rendelést hoz létre, ha a line_items előfizetéses terméket tartalmaz, a rendelésből előfizetés lesz
GET /wp-json/wc/v3/subscriptions	Előfizetések listája lapozással és szűrőkkel (állapot, ügyfél, termék, keresés, dátum)
GET, PUT, DELETE /wp-json/wc/v3/subscriptions/<id>	Egy előfizetés lekérése, módosítása, törlése
GET /wp-json/wc/v3/subscriptions/<id>/orders	Az előfizetés rendelései, jelölve, hogy eredeti, megújítási, váltási vagy újrafeliratkozási rendelés
/wp-json/wc/v3/subscriptions/<id>/notes	Jegyzetek létrehozása, listázása, lekérése, törlése

A hitelesítés a WooCommerce REST API szokásos módja (fogyasztói kulcs és titok).

Mikor nem ez kell

• Előfizetést nem lehet közvetlenül a /subscriptions végpontra küldött POST-tal létrehozni, csak előfizetéses terméket tartalmazó rendeléssel.
• Az egyezés a WooCommerce Subscriptions API-val nagyrészt, nem teljesen áll fenn.
• Néhány mező csak olvasható (például az id, a total, a date_created).
• A dátumokat YYYY-mm-dd H:i:s formában kell megadni, a billing_period értéke csak D, W, M vagy Y lehet.
• Működéséhez kell a Flexible Subscriptions bővítmény és a WooCommerce REST API.

Első lépések

1. Telepítsd és kapcsold be a bővítményt.
2. Hozz létre WooCommerce REST API-kulcsot a WooCommerce hitelesítési útmutatója szerint.
3. Hozz létre egy előfizetéses terméket.
4. Küldj POST kérést a /wp-json/wc/v3/orders címre az előfizetéses termékkel, és set_paid: true értékkel.
5. A kapott subscriptions tömb azonosítóival kérd le a végpontokon az előfizetést.

Hasznos linkek

• A REST API dokumentációja
• A Flexible Subscriptions felhasználói dokumentációja
• A WooCommerce REST API hitelesítése