Skip to main content
Kolekce Postman pro rozhraní Living Security API v1 je generována ze stejné specifikace OpenAPI, ze které vychází reference API v1, takže vždy odpovídá zveřejněné smluvní definici. Pokrývá všechny operace /v1, seskupené podle zdrojů, s předkonfigurovaným ověřováním.

Stažení

Před zpřístupněním souboru se u odkazů ke stažení zobrazí výzva k přihlášení pomocí účtu Living Security.

Kolekce Living Security API v1

Postman Collection v2.1 se všemi operacemi /v1 a předkonfigurovaným ověřováním Basic. Kolekce baseUrl je prázdná – před odesláním požadavku vyberte regionální prostředí.Stáhnout kolekci

Produkční prostředí (USA)

baseUrl přednastavená na https://api.us-east-1.livingsecurity.ai/v1, s prázdnými proměnnými apiKeySecret a contractVersion, které je třeba vyplnit.Stáhnout produkční prostředí pro USA

Produkční prostředí (EU)

baseUrl přednastavená na https://api.eu-west-1.livingsecurity.ai/v1, s prázdnými proměnnými apiKeySecret a contractVersion, které je třeba vyplnit.Stáhnout produkční prostředí pro EU

Šablona prostředí

Stejné proměnné s prázdnou hodnotou baseUrl, pro neprodukční konfigurace.Stáhnout šablonu prostředí

Nastavení v aplikaci Postman

1

Import souborů

V aplikaci Postman zvolte Import a přetáhněte soubor kolekce spolu s produkčním prostředím (USA) nebo produkčním prostředím (EU), které odpovídá vaší organizaci. Viz Regiony.
2

Vytvoření klíče API

Na Nástěnce otevřete Nastavení → Integrace & Developers → Developer Hub, vytvořte servisní účet a poté klíč API. Tajný klíč začíná lsk_live_ a zobrazí se pouze jednou – ihned si jej zkopírujte. Podrobnosti najdete v části Klíče API.
3

Vložení tajného klíče

Nastavte proměnnou apiKeySecret – buď v naimportovaném prostředí (doporučeno; jde o proměnnou typu secret), nebo na kartě Proměnné v kolekci.
4

Odeslání požadavku

Vyberte naimportované regionální prostředí, otevřete libovolný požadavek – například Organizace → Retrieve the organization – a klikněte na Odeslat. Neodesílejte požadavky, dokud není vybráno prostředí; proměnná kolekce baseUrl je záměrně prázdná.

Jak je předkonfigurováno ověřování

Kolekce nastavuje ověřování Basic na úrovni kolekce s uživatelským jménem apikey a heslem {{apiKeySecret}}. Rozhraní API přijímá tajný klíč v obou polích ověřování Basic, takže po nastavení proměnné funguje bez dalších úprav. Pokud dáváte přednost ověřování typu bearer, změňte typ Authorization v kolekci na Bearer Token a jako token použijte {{apiKeySecret}} – rozhraní API přijímá stejný tajný klíč oběma způsoby. Použití hlavičky Bearer s klíčem API nevyžaduje OAuth. Pokud chcete použít OAuth, nastavte do pole Bearer Token místo tajného klíče API svůj přístupový token OAuth. Výběr metody najdete v části Ověřování a nastavení tokenu a klienta v části Přihlašovací údaje klienta OAuth.

Hlavička verze smlouvy

Každý požadavek obsahuje hlavičku Living-Security-Version přednastavenou na {{contractVersion}}, která je ve výchozím stavu zakázána. Ponecháte-li ji zakázanou, použije se verze smlouvy připnutá pro vaši organizaci. Jejím povolením připnete požadavek ke konkrétní zveřejněné verzi – zveřejněné verze najdete v seznamu změn.

Parametry dotazu a těla požadavků

Filtry koncových bodů se seznamy (limit, page_token a filtry specifické pro daný zdroj) jsou součástí každého požadavku, ale jsou zakázané, takže čerstvě naimportovaná kolekce úspěšně volá každý koncový bod. Povolte a vyplňte ty, které potřebujete – jak funguje page_token, popisuje část Stránkování. Těla požadavků u operací POST jsou předvyplněna zástupnými hodnotami příslušných typů.
Kolekce se znovu generuje z publikované specifikace OpenAPI při každé změně smlouvy – místo úprav požadavků, které chcete udržovat aktuální, si stáhněte novou kopii.