/v1 műveletet lefedi erőforrások szerint csoportosítva, előre konfigurált hitelesítéssel.
Letöltés
A letöltési hivatkozások a fájl kiszolgálása előtt a Living Security-fiókjával történő bejelentkezésre kérik.
Living Security API v1 gyűjtemény
Postman Collection v2.1 az összes
/v1 művelettel és előre konfigurált Basic hitelesítéssel. A(z) baseUrl gyűjtemény üres – kérés küldése előtt válasszon regionális környezetet.A gyűjtemény letöltéseÉles (US) környezet
baseUrl előre beállítva erre: https://api.us-east-1.livingsecurity.ai/v1, üres apiKeySecret és contractVersion változókkal, amelyeket ki kell töltenie.Az amerikai éles környezet letöltéseÉles (EU) környezet
baseUrl előre beállítva erre: https://api.eu-west-1.livingsecurity.ai/v1, üres apiKeySecret és contractVersion változókkal, amelyeket ki kell töltenie.Az európai éles környezet letöltéseKörnyezetsablon
Ugyanezek a változók üres
baseUrl értékkel, nem éles környezetekhez.A környezetsablon letöltéseBeállítás a Postmanben
1
A fájlok importálása
A Postmanben válassza az Import lehetőséget, majd húzza be a gyűjtemény fájlját, valamint a szervezetnek megfelelő Production (US) vagy Production (EU) környezetet. Lásd: Régiók.
2
API-kulcs létrehozása
A Műszerfalon nyissa meg a Beállítások → Integrációk & Developers → Developer Hub menüpontot, hozzon létre egy szolgáltatásfiókot, majd hozzon létre egy API-kulcsot. A kulcs titkos értéke
lsk_live_ előtaggal kezdődik, és csak egyszer jelenik meg – azonnal másolja ki. További részletekért lásd: API-kulcsok.3
A titkos érték beillesztése
Állítsa be a(z)
apiKeySecret változót – vagy az importált környezetben (ajánlott; titkos típusú változó), vagy a gyűjtemény Variables lapján.4
Kérés küldése
Válassza ki az importált regionális környezetet, nyisson meg egy tetszőleges kérést – például az Organization → Retrieve the organization kérést –, majd kattintson a Send gombra. Ne küldjön kérést, amíg nincs kiválasztva környezet; a gyűjtemény
baseUrl értéke szándékosan üres.Az előre konfigurált hitelesítés működése
A gyűjtemény a gyűjtemény szintjén Basic hitelesítést állít be,apikey felhasználónévvel és {{apiKeySecret}} jelszóval. Az API a kulcs titkos értékét bármelyik Basic hitelesítési mezőben elfogadja, így a változó beállítása után ez módosítás nélkül működik.
Ha a bearer hitelesítést részesíti előnyben, módosítsa a gyűjtemény Authorization típusát Bearer Token értékre, és tokenként használja a(z) {{apiKeySecret}} változót – az API mindkét módon ugyanazt a titkos értéket fogadja el.
API-kulccsal használt Bearer fejléc nem igényel OAuth-ot. OAuth használatához a Bearer Token mezőbe az API-kulcs titkos értéke helyett az OAuth hozzáférési tokent adja meg. A módszer kiválasztásához lásd: Hitelesítés, a token és az ügyfél beállításához pedig: OAuth client credentials.
Szerződésverzió-fejléc
Minden kérés tartalmaz egyLiving-Security-Version fejlécet, amely alapértelmezés szerint {{contractVersion}} értékre van állítva, és le van tiltva. Hagyja letiltva, ha a szervezet rögzített szerződésverzióját kívánja használni. Engedélyezze, ha a kérést egy adott közzétett verzióhoz szeretné rögzíteni – a közzétett verziókat lásd a módosításnaplóban.
Lekérdezési paraméterek és törzsek
A listavégpontok szűrői (limit, page_token és az erőforrás-specifikus szűrők) minden kérésben szerepelnek, de le vannak tiltva, így egy friss importálás után minden végpont sikeresen hívható. Engedélyezze és töltse ki a szükségeseket – a(z) page_token működéséről lásd: Lapozás. A(z) POST műveletek kéréstörzsei típusos helyőrző értékekkel vannak előre kitöltve.
A gyűjtemény minden szerződésmódosításkor újragenerálódik a közzétett OpenAPI-specifikációból – az aktuális állapot megőrzéséhez töltsön le új másolatot ahelyett, hogy a kéréseket szerkesztené.