Propojení vašich nástrojů přes API

API umožňuje aplikaci třetí strany programově přistupovat k datům vaší organizace: členské základně, kalendářům, rezervacím a fakturaci. Aktivuje se dvěma kliknutími a chrání ji klíč, seznam povolených adres a sledování spotřeby.

Zjistěte, zda je API určeno pro vás

API je určeno pro vývojáře, nikoli pro vedoucího organizace. Slouží k propojení vašeho účtu se softwarem, který si necháváte naprogramovat nebo nastavit: webem na míru, účetním nástrojem, vlastní informační obrazovkou nebo propojením s jiným systémem.

Pro běžné potřeby — získání seznamu členů, hromadnou aktualizaci Předplatných, předání čísel výboru — postačí moduly importu, exportu a reportů, a to bez jediného řádku kódu.

API je nabízeno v beta verzi: jeho fungování se ještě může měnit.

Aktivace API a získání klíče

1. Přejděte do Administrace›Nastavení›API BETA.
2. Aktivujte Aktivovat modul API a klikněte na Uložit.
3. Zobrazí se váš API klíč: zkopírujte jej tlačítkem Kopírovat a předejte jej výhradně nástroji, který připojujete.

Klíč se předává v HTTP hlavičce X-API-Key každého požadavku. Volání musí probíhat výhradně přes HTTPS; nezašifrovaný požadavek nebude přijat.

Ochrana klíče

Několik zásad je vhodné připomenout nástroji nebo dodavateli, který jej používá:

• nikdy neukládejte klíč do repozitáře kódu; uchovávejte jej v konfiguračním souboru mimo repozitář nebo ve správci tajných údajů;
• omezte povolené adresy, jakmile nástroj volá z pevného serveru;
• při nejmenším podezření klíč vygenerujte znovu — náhodné zveřejnění, únik protokolů, ukončení spolupráce s dodavatelem.

Tlačítko Regenerovat vyžádá potvrzení a poté okamžitě zneplatní starý klíč. Všechny aplikace, které jej používaly, přestanou fungovat, dokud neobdrží nový: upozorněte je před kliknutím.

Omezení přístupu podle IP adresy

Aktivujte Omezení podle IP adresy: přijímány budou pouze požadavky z adres, které uvedete, a to nejvýše z 10 adres IPv4. Zadejte každou adresu a potvrďte pomocí Přidat; vaše aktuální adresa je zobrazena na obrazovce jako pomůcka.

Jde o nejúčinnější a zároveň nejčastěji opomíjenou ochranu: i vyzrazený klíč omezený na adresu vašeho dodavatele zůstane jinde nepoužitelný.

Sledování spotřeby

Obrazovka průběžně zobrazuje, co váš klíč spotřebovává:

• Použití této minuty a Dnešní využití, každá vztažená ke svému limitu, pokud je limit nastaven;
• Statistiky využití: Tento týden, Tento měsíc, Celkem a Poslední požadavek.

Nad uvedené limity jsou další požadavky dočasně odmítány. Počítadlo, které se trvale drží na svém maximu, obvykle signalizuje špatně nastavený nástroj, který si stále znovu vyžaduje stejná data místo toho, aby je ukládal do cache.

Datum posledního požadavku je užitečné v obráceném smyslu: klíč, který je aktivní, ale několik měsíců nebyl použit, je klíč k deaktivaci.

Objevte možnosti API

Kompletní dokumentace s parametry a příklady volání je zobrazena ve spodní části obrazovky modulu. V hlavních bodech:

• Uživatelé: jde o jediný upravitelný zdroj. Účty můžete vypisovat, prohlížet, vytvářet, upravovat a mazat.
• Konfigurace: Předplatné, profily, skupiny a věkové kategorie lze prohlížet, nastavovat je však lze pouze v aplikaci.
• Rezervace: kalendáře, dostupné Časové úseky, Rezervace a Popisky lze prohlížet.
• Fakturace: Fakturační účty, Objednávky a platby lze prohlížet.