API klíče a API

API klíč je heslo, které patří programu místo osoby. Zacházejte s ním stejně: vydávejte jeden na systém a nahraďte ho, když se systém změní.

Vytvořit klíč

1. Otevřít API → API management a stiskněte Nový klíč.
2. Dejte tomu jméno, které říká, který systém to používá.
3. Zvolte jeho Oprávnění: Plný přístup, nebo pouze oblasti, které systém potřebuje. Většina oblastí rozlišuje čtení, vytváření a změny.
4. Vyberte datum vypršení platnosti, nebo žádné.
5. Použijte Zobrazit a Kopírovat na klíčovou kartu pro předání klíče volajícímu systému. Systém jej odešle v authtoken záhlaví.

Každá klíčová karta ukazuje oprávnění, datum vytvoření, Poslední použití a odznak jako „aktivní“ nebo „vyprší za 5 dní“.

Obnovit klíč před jeho vypršením

Čtrnáct dní před vypršením klíče obdržíte jedno upozornění v zvonku. Stiskněte Obnovit na klíčovou kartu a vyberte nové datum vypršení. IDup vytvoří nový klíč se stejnými oprávněními. Okamžitě jej zkopírujte, protože toto zobrazení se objeví pouze jednou. Starý klíč zůstává platný až do svého vypršení, takže můžete systém přepnout bez přerušení.

Oblasti, ke kterým máte přístup

API pokrývá vaše zákaznická data a v závislosti na vašem plánu také nemovitosti a pronájmy, vyhledávací profily, daňové soubory, soubory pro správce, účetnictví, mzdové běhy a skenování účtenek. AI Studio a schránka mají své vlastní oblasti. Průvodce API uvádí pouze oblasti, které váš plán zahrnuje.

Průvodce API

Otevřít Dokumentace záložku na stránce správy API, nebo API → API průvodce. Každá oblast ukazuje svá pole, příklady požadavků, které můžete zkopírovat, příklady odpovědí a chybové kódy.

Webhooks a další rozhraní

• The Webhooks záložka odesílá události do vašeho systému, jakmile se stanou — viz Odeslat události do vašeho vlastního systému pomocí webhooků.
• Pokud je zapnutá Zákaznická API, a Nastavení API pro zákazníky záložka otevírá její nastavení, například zda se zákazníci mohou registrovat přes API.
• Automatizace / Pracovní postupy → Technické rozhraní vydává token pro rozhraní GraphQL.
• AI Studio → Osobní API klíče je samostatná sada klíčů.

Uchovávání v bezpečí

1. Jeden klíč na systém, nikdy sdílený.
2. Dejte klíči pouze oprávnění, která systém potřebuje.
3. Nastavte datum vypršení platnosti a obnovujte podle plánu.
4. Smažte klíč, jakmile někdo, kdo ho znal, odejde, nebo je systém vypnut.