Loading
Ebben a cikkben megtudhatja, hogyan konfigurálhatja és használhatja a systeme.io nyilvános API-t, beleértve azt is, hogyan generálhat API-kulcsokat és milyen műveleteket végezhet el.
1. Mi az az API?
Az API az „Application Programming Interface”, vagyis az alkalmazásprogramozási interfész rövidítése, egy sor utasítás, amelyekkel egy platform szolgáltatásokat nyújt más platformok számára. Ez egy stratégiai kapu külső fejlesztők számára, lehetővé téve számukra, hogy a platform specifikus funkcióit vagy adatait strukturált és biztonságos módon elérhessék. Ez olyan, mint egy sor előre elkészített eszköz, amelyek megkönnyítik új alkalmazások, szolgáltatások vagy kombinációk létrehozását.
Röviden, a systeme.io más platformokat is kiszolgál, hogy ott nyújtsa szolgáltatásait, ahol azok értéket adnak.
2. Hogyan működik a nyilvános API-nk?
API-nk gondosan kiválasztott funkciókat tár ki, lehetővé téve a fejlesztők számára, hogy átláthatóan és hatékonyan lépjenek kapcsolatba platformunkkal. Ha többet szeretne tudni a működéséről, olvassa el hivatalos API dokumentációnkat.
3. Hogyan hozhat létre API-kulcsokat
Az API-kulcsok egyedi azonosítók, amelyek hitelesítik a kéréseket a Nyilvános API-hoz. Lehetővé teszik, hogy programozási módon hozzáférjen és kezeljen különböző erőforrásokat a platformunkon.
Nyilvános API-kulcs létrehozásához kattintson a profilképére, válassza a Beállítások (1) menüpontot, majd görgessen le az MCP & API kulcsok (2) részhez.
Kattintson a Létrehozás (3) gombra a nyilvános API-kulcs létrehozásának megkezdéséhez.
A „Nyilvános API-kulcs létrehozása” felugró ablakban adjon meg egy nevet, majd válassza ki az API-kulcs lejárati dátumát és időpontját.
Ha elkészült, kattintson a Mentés (4) gombra.
Megjegyzés: Ha az API-kulcsot határozatlan időre szeretné aktívvá tenni, hagyja üresen a „Lejárat” mezőt.
Az API-kulcs most készen áll.
4. Mit tehet az API-nkkal?
API-nk érdekes lehetőségeket kínál. Az alábbiakban megtalálja a főbb műveleteket, amelyeket a nyilvános API-nkkal elvégezhet:
a. Kapcsolattartók, címkék és egyéni mezők:
- Kapcsolatok kezelése: Új kapcsolatok létrehozása, meglévő kapcsolatok frissítése, közönség listázása fejlett szűrőkkel vagy kapcsolatok törlése.
- Címkék kezelése: Címkék létrehozása, hozzárendelése, listázása és eltávolítása a kapcsolatoktól.
- Egyéni mezők: Elérhető kapcsolati egyéni mezők és azok azonosítóinak (slugok) lekérése a kapcsolati információk helyes kitöltéséhez.
b. Hírlevelek:
- Hírlevelek létrehozása és frissítése: Új hírlevél vázlatok létrehozása vagy meglévők részleges frissítése. Megadhatja a szerkesztő típusát (Klasszikus vagy Vizuális), lekérheti a teljes HTML-tartalmat, és kifejezetten beállíthatja a feladó nevét és e-mail címét.
- Listázás és lekérés: Létező hírlevelek böngészése vagy egy adott hírlevél teljes tartalmának lekérdezése azonosítójával.
c. Tölcsérek és oldalszerkesztő:
- Tölcsérek kezelése: Új tölcsérek létrehozása, új lépések (oldalak) hozzáadása hozzájuk, és egy adott tölcsér összes lépésének listájának lekérése.
- Oldalszerkesztő: Generált oldal tartalmának közvetlen mentése tölcsérlépéseihez vagy weboldal oldalakhoz (teljes cserével), és JSON sémák lekérése adott oldaltípusokhoz.
d. Árképzési csomagok és kuponok:
- Létrehozás, szerkesztés, és törlés: Új árképzési csomagok és kuponok létrehozása, vagy meglévők részleges frissítése és törlése.
- Listázás és keresés: Az összes meglévő árképzési csomag és kupon böngészése, vagy adott elemek lekérése azonosítójuk alapján.
e. Tanfolyamok és diákok:
- Tanfolyamok és diákok kezelése: Meglévő tanfolyamok listájának lekérése és az éppen beiratkozott diákok listájának lekérése.
- Diákok beiratkozása: Kapcsolatok programozott beiratkozása az egyes tanfolyamokba.
Megjegyzés a tanfolyamokról: A tanfolyami csomagok támogatása a jövőbeni frissítésekben lesz hozzáadva.
f. Közösségek:
- Közösségek kezelése: Meglévő közösségek listájának lekérése és egy adott közösség jelenlegi tagjainak hozzáférése.
- Tagok meghívása: Új felhasználók programozott meghívása a közösségekbe való csatlakozásra az elérhetőségeik ID-jének megadásával.
g. Automatizálási szabályok:
- Szabályok kezelése: Programozottan összekapcsolhatóak a gyakori események és műveletek, meglévő szabályok frissítése (például egy esemény módosítása miközben a kiváltó ugyanaz marad), vagy szabályok puha törlése.
- Listázás és lekérés: Automatizálási szabályok böngészése vagy egy adott szabály lekérése azonosítójával.
h. Előfizetések:
- Előfizetések kezelése: Az összes erőforrás listájának lekérése egy előfizetésben harmadik fél platformjáról, és egy előfizetés lemondása vagy azonnal, vagy a számlázási ciklus végén.
i. Webhookok
- Webhookok kezelése: Új webhookok programozott létrehozása, hogy valós idejű értesítéseket kapjon, meglévő webhook listák lekérése, és már nem szükséges webhookok eltávolítása.
Megjegyzések:
- Minden tokennek egyedi névvel kell rendelkeznie az egyszerű azonosítás és kezelés érdekében.
- A token kizárólag közvetlenül a létrehozása után másolható ki. Ha elfelejtette kimásolni, törölje, majd hozzon létre egy újat.
- Biztonsági okokból e-mail értesítést küldünk minden alkalommal, amikor új nyilvános API-kulcs jön létre a systeme.io fiókjában.
- Fiókonként legfeljebb 3 API-kulcsot hozhat létre.
További információ: API-dokumentáció.