Klíče API

Používejte klíče API, když externí systém potřebuje volat Siesta AI bez interaktivního přihlášení uživatele. Typické příklady zahrnují backendové integrace, naplánované úlohy, předávání ve stylu webhook nebo interní služby, které potřebují vytvářet nebo číst objekty Siesta AI prostřednictvím externího API.

Klíč API patří organizaci a je vázán na uživatele, který ho vytvořil. V backendových integracích se autentizace pomocí klíče API používá pro požadavky /api/v1 tím, že se klíč posílá spolu s ID organizace.

Použijte kartu k:

• vytvoření pojmenovaného klíče API pro konkrétní integraci nebo prostředí,
• vyhledání existujících klíčů podle názvu,
• zobrazení nebo zkopírování hodnoty klíče pro nastavení,
• odstranění klíče, který se již nepoužívá,
• zkontrolování, kdy byl klíč vytvořen.

Pro externí API volání posílejte tyto hlavičky:

X-Api-Key: <api-key-value>
X-Org-Id: <organization-id>

Udržujte klíče API mimo výzvy, veřejné dokumenty, snímky obrazovky, frontendový kód a sdílené chatové zprávy. Uložte je do tajného správce systému, který je volá, nebo do proměnných prostředí. Pokud je klíč vystaven, vytvořte náhradní klíč, aktualizujte integraci a odstraňte starý klíč.

Doporučený vzor pojmenování:

<system>-<environment>-<purpose>

Příklady:

• crm-prod-sync
• datawarehouse-dev-import
• webhooks-prod-dispatch