Referenčná príručka API pre vývojárov
Pripojte vlastnú aplikáciu k svojmu pracovnému priestoru: REST API, jeho kľúče a rozsahy, chyby, limity požiadaviek a webhooky.
Kde to nájdete
⚙️ Nastavenia › Referenčná príručka API · Úvodná stránka › Zdroje › Referenčná príručka API
Otvoriť túto obrazovku
Kroky
- Otvorte „Referenčná príručka API“ v bočnom paneli, alebo „Referenčná príručka API“ v ponuke „Zdroje“ na úvodnej stránke.
- Začnite v „Začnite tu“: „Základná URL a konvencie“, „Overovanie“ a „Rozsahy“.
- Vyhľadajte „Koncové body“ podľa skupiny; každý zobrazuje parametre, telo požiadavky, odpoveď a chyby s príkladmi.
- Pred spustením do ostrej prevádzky si prečítajte „Chyby a stavové kódy“, „Limity požiadaviek“ a „Webhooky (odchádzajúce)“. „OpenAPI JSON“ stiahne celú špecifikáciu.
Riešenie problémov
Ako získam kľúč API?
Kľúče sa vydávajú pre váš pracovný priestor na požiadanie; v aplikácii ich zatiaľ vytvoriť nemožno. Kľúče vášho pracovného priestoru sú uvedené na stránke pre vývojárov v oblasti AI, kde môžu ľudia spravujúci pracovný priestor tiež pridávať a testovať koncové body webhookov.
Tipy
- API volajte len zo svojho servera. Nikdy nevkladajte kľúč do webovej stránky ani mobilnej aplikácie.
Dobré vedieť
- Referenčná príručka API je čitateľná bez prihlásenia.
Súvisiace návody
- Ako nájdem koncový bod a skopírujem príklad? Hľadajte v referenčnej príručke API, skočte na koncový bod a skopírujte jeho príklad alebo odkaz.
- Ako si prečítam časté otázky (Dokumentácia)? Prečítajte si krátke odpovede o tom, čo produkt dnes robí: začíname, jazyky a hlasy, testovacie hovory, telefónne čísla, plány a účet.
- Funkcie Úplný katalóg funkcií kontaktného centra, každá poctivo označená ako vydaná alebo plánovaná.