API kľúče a API

API kľúč je heslo, ktoré patrí programu namiesto osoby. Zaobchádzajte s ním rovnako: vydajte jeden na systém a nahraďte ho, keď sa systém zmení.

Vytvoriť kľúč

1. Otvoriť API → API správa a stlačte Nový kľúč.
2. Dajte mu názov, ktorý hovorí, ktorý systém ho používa.
3. Vyberte jeho Oprávnenia: Plný prístup, alebo iba oblasti, ktoré systém potrebuje. Väčšina oblastí rozlišuje čítanie, vytváranie a zmenu.
4. Vyberte dátum vypršania platnosti, alebo žiadny.
5. Použiť Zobraziť a Kopírovať na karte kľúča, aby ste kľúč odovzdali volajúcemu systému. Systém ho odošle v authtoken hlavička.

Každá kľúčová karta ukazuje oprávnenia, dátum vytvorenia, Posledné použitie a odznak ako „aktívny“ alebo „vyprší o 5 dní“.

Obnoviť kľúč pred jeho vypršaním

Štrnásť dní pred vypršaním kľúča dostanete jedno upozornenie v zvončeku. Stlačte Obnoviť na karte kľúča a vyberte nový dátum vypršania platnosti. IDup vytvorí nový kľúč s rovnakými oprávneniami. Skopírujte ho okamžite, pretože tento displej sa zobrazí len raz. Starý kľúč zostáva platný až do svojho vypršania, takže môžete systém prepnúť bez prerušenia.

Oblasti, ktoré môžete dosiahnuť

API pokrýva vaše zákaznícke údaje a v závislosti od vášho plánu aj nehnuteľnosti a nájmy, vyhľadávacie profily, daňové súbory, súbory správcu, účtovníctvo, mzdy a skenovanie účteniek. AI Studio a schránka majú svoje vlastné oblasti. Sprievodca API uvádza iba oblasti, ktoré váš plán zahŕňa.

Sprievodca API

Otvorte Dokumentácia karta na stránke správy API, alebo API → API príručka. Každá oblasť zobrazuje svoje polia, príklady požiadaviek, ktoré môžete kopírovať, príklady odpovedí a chybové kódy.

Webhooks a iné rozhrania

• The Webhooks karta posiela udalosti do vášho systému, ako sa dejú — pozri Odoslať udalosti do vášho vlastného systému pomocou webhookov.
• Ak je zapnuté Customer API, a Nastavenia API zákazníkov karta otvára jej nastavenia, napríklad či sa zákazníci môžu registrovať cez API.
• Automatizácia / Pracovné postupy → Technické rozhranie vydáva token pre rozhranie GraphQL.
• AI Studio → Osobné API kľúče je samostatná sada kľúčov.

Uchovávanie v bezpečí

1. Jeden kľúč na systém, nikdy zdieľaný.
2. Dajte kľúču iba povolenia, ktoré systém potrebuje.
3. Nastavte dátum vypršania a obnovujte podľa plánu.
4. Vymažte kľúč, akonáhle niekto, kto ho poznal, odíde, alebo ak je systém vypnutý.