Jak používat veřejné API (rozhraní pro programování aplikací) v systeme.io

V tomto článku se dozvíte, jak nakonfigurovat a používat veřejné API v systeme.io, včetně toho, jak generovat API klíče a jaké akce můžete provádět.

1. Co je to API?

Zkratka API znamená "Application Programming Interface" (rozhraní pro programování aplikací), což je série pokynů, kterými platforma nabízí služby jiným platformám. Je to strategická brána pro externí vývojáře, umožňující jim přístup ke specifické funkčnosti nebo datům z platformy strukturovaným a bezpečným způsobem. Je to jako sada připravených nástrojů, které usnadňují vytváření nových aplikací, služeb nebo jejich kombinací.

Stručně řečeno, systeme.io se otevírá jiným platformám, aby poskytovalo své služby tam, kde přináší přidanou hodnotu.

2. Jak funguje naše veřejné API?

Naše API poskytuje pečlivě vybranou sadu funkcí, které umožňují vývojářům transparentně a účinně interagovat s naší platformou. Pokud se chcete dozvědět více o tom, jak funguje, můžete si přečíst naši oficiální dokumentaci API.

3. Jak generovat vaše API klíče

API klíče jsou jedinečné identifikátory, které ověřují požadavky na naše veřejné API. Umožňují vám programově přistupovat k různým zdrojům na naší platformě a spravovat je.

Pro vytvoření veřejného API klíče klikněte na svůj profilový obrázek, vyberte Nastavení (1) a posuňte se dolů na MCP & API klíče (2).

Klikněte na Vytvořit (3) a zahajte vytváření veřejného API klíče.

V okně Vytvořit veřejný API klíč zadejte název a vyberte datum a čas vypršení platnosti API klíče.

Po dokončení klikněte na Uložit (4).

Poznámka: Chcete-li ponechat API klíč aktivní bez omezení, ponechte pole „Vypršení“ prázdné.

Váš klíč je nyní připraven.

4. Co můžete s naším API udělat?

Naše API otevírá řadu zajímavých možností. Níže najdete hlavní akce, které můžete provádět pomocí našeho veřejného API:

a. Kontakty, tagy a vlastní pole:

• Správa kontaktů: Vytvářejte nové kontakty, aktualizujte stávající, zobrazte si své publikum s pokročilými filtry nebo odstraňujte kontakty.
• Správa tagů: Vytvářejte, přiřaďte, zobrazujte a odstraňujte tagy z kontaktů.
• Vlastní pole: Získejte dostupná vlastní pole kontaktu a jejich identifikátory (slugy) pro správné vyplnění informací o kontaktu.

b. Newslettre:

• Vytváření a aktualizace newslettre: Vytvářejte nové návrhy newslettre nebo částečně aktualizujte stávající. Můžete definovat typ editoru (Klasický nebo Vizualní), získat plný HTML obsah a explicitně nastavit jméno a emailovou adresu odesílatele.
• Seznam a načítání: Procházejte své existující newslettre nebo získejte plný obsah určitého newslettre pomocí jeho ID.

c. Funnel a editor stránek:

• Správa funnelů: Vytvářejte nové funnely, přidávejte nové kroky (stránky) do nich a získejte seznam všech jednotlivých kroků v rámci konkrétního funnelu.
• Editor stránek: Uložte generovaný obsah stránky přímo do kroků funnelu nebo webových stránek (úplná náhrada) a získejte JSON schémata pro specifické typy stránek.

d. Cenové plány a kupóny:

• Vytvářejte, upravujte a odstraňujte: Generujte nové cenové plány a kupóny, nebo částečně aktualizujte a odstraňujte stávající.
• Seznam a vyhledání: Procházejte všechny své existující cenové plány a kupóny, nebo získejte konkrétní položky podle jejich ID.

e. Kurzy a studenti:

• Správa kurzů a studentů: Získat seznam svých existujících kurzů a získat seznam studentů aktuálně zapsaných.
• Zapisování studentů: Programově zapsat kontakty do vašich individuálních kurzů.

Poznámka ke kurzům: Podpora pro balíčky kurzů bude přidána v budoucích aktualizacích.

f. Komunity:

• Správa komunit: Získat seznam vašich existujících komunit a přístup k seznamu aktuálních členů v rámci konkrétní komunity.
• Pozvat členy: Programově pozvat nové uživatele do vašich komunit poskytnutím jejich ID kontaktu.

g. Pravidla automatizace:

• Správa pravidel: Programově propojit běžné události a akce, aktualizovat stávající pravidla (např. změna akce při zachování stejného spouštěče) nebo soft‑smazat pravidla.
• Seznam a načítání: Procházejte svá pravidla automatizace nebo získejte určité pravidlo podle jeho ID.

h. Předplatná:

• Správa předplatných: Získat seznam všech zdrojů v předplatném z externích platforem a zrušit předplatné buď ihned, nebo na konci fakturačního cyklu.

i. Webhooky

• Správa webhooků: Programově vytvářet nové webhooky pro přijímání notifikací v reálném čase, získat seznamy svých existujících webhooků a odstraňovat webhooky, které již nejsou potřeba.

Poznámky:

• Pro snadnou identifikaci a správu musí mít každý token jedinečný název.
• Token lze zkopírovat pouze ihned po jeho vytvoření. Pokud jste si token nezkopírovali, smažte jej a vytvořte nový.
• Z bezpečnostních důvodů vám zašleme e-mailové upozornění pokaždé, když bude ve vašem účtu systeme.io vytvořen nový veřejný API klíč.
• Na jeden účet můžete vytvořit až 3 klíče API.

Další informace: API dokumentace.