API gyorsindítási útmutató

Hozzon létre egy szolgáltatásfiókot és egy API-kulcsot a Developer Hubban, majd küldje el az első kérését. Ez a gyorsindítási útmutató API-kulcsos hitelesítést használ; OAuth-kliensre nincs szükség. Ha az integrációjához rövid élettartamú OAuth-hozzáférési tokenek szükségesek, lásd a Hitelesítés című részt.

Előfeltételek

Rendszergazdai hozzáférés a Living Security Műszerfalhoz.
A Developer Hub látható a Beállítások → Integrációk & Developers → Developer Hub menüpont alatt.

Hitelesítő adatok létrehozása

Szolgáltatásfiók létrehozása

A Developer Hubban nyissa meg a Service accounts lapot, és hozzon létre egy fiókot. Adjon neki beszédes nevet (például reporting-pipeline), és rendelje hozzá azokat a jogosultságokat, amelyeket a kulcsai használhatnak – ehhez az útmutatóhoz organization:read elegendő.A fiók jogosultságai minden, a fiók alatt létrehozott kulcs felső korlátját jelentik: egy kulcs soha nem tehet többet, mint amit a szolgáltatásfiók megenged.

API-kulcs létrehozása

Nyissa meg a szolgáltatásfiók részletes oldalát, és hozzon létre egy kulcsot. Válassza ki a kifejezetten ennek a kulcsnak szükséges jogosultságokat (a fiók jogosultságainak egy részhalmazát), valamint a lejáratot – 30, 90 vagy 365 nap, illetve egyéni időtartam. A lejárat megadása kötelező.A kulcs titkos értéke lsk_live_ előtaggal kezdődik, és csak egyszer jelenik meg. Másolja azonnal egy titokkezelőbe; később nem kérhető le.

Soha ne commitolja az API-kulcsok titkos értékeit verziókezelőbe, és ne ágyazza be őket kliensoldali kódba. Bárki, aki birtokolja a titkos értéket, a kulcs jogosultságaival járhat el.

Régió kiválasztása

A szervezet adattárolási helyének megfelelő regionális /v1 gazdagépet hívja meg. A kulcsok csak ezen a gazdagépen hitelesítenek.

Régió	Alap-URL
US	`https://api.us-east-1.livingsecurity.ai/v1`
EU	`https://api.eu-west-1.livingsecurity.ai/v1`

Ha nem biztos abban, melyik gazdagépet használja, lásd a Régiók című részt. Egy érvényes kulcs, amelyet a másik régióba küld, unauthorized hibával végződik. A gazdagép váltásához használja az alábbi minta régió legördülő menüjét.

Az első kérés elküldése

Töltse be a LIVING_SECURITY_API_KEY értéket a titokkezelőből a kérést indító folyamat környezetébe. Az alábbi példák úgy olvassák be, hogy nem ágyaznak be titkos értéket a forráskódba. Pythonhoz először telepítse a következőt: requests.Hívja meg az API-t úgy, hogy a titkos értéket a HTTP Basic auth jelszó- vagy felhasználónévmezőjében adja meg – mindkettő működik, így azok a kliensek, amelyek mindkét mező kitöltését megkövetelik (például a Power BI Web connectora), a másik mezőbe egy helyőrzőt, például apikey értéket írhatnak.

curl --fail-with-body --connect-timeout 5 --max-time 30 \
  https://api.eu-west-1.livingsecurity.ai/v1/organization \
  -u "apikey:${LIVING_SECURITY_API_KEY:?Set LIVING_SECURITY_API_KEY}" \
  -H "Living-Security-Version: 2026-07-01"

curl --fail-with-body --connect-timeout 5 --max-time 30 \
  https://api.eu-west-1.livingsecurity.ai/v1/organization \
  -u "${LIVING_SECURITY_API_KEY:?Set LIVING_SECURITY_API_KEY}:" \
  -H "Living-Security-Version: 2026-07-01"

import os
import requests

BASE = "https://api.eu-west-1.livingsecurity.ai/v1"

response = requests.get(
    f"{BASE}/organization",
    auth=("apikey", os.environ["LIVING_SECURITY_API_KEY"]),
    headers={"Living-Security-Version": "2026-07-01"},
    timeout=(5, 30),
    allow_redirects=False,
)
response.raise_for_status()
if response.status_code != 200:
    raise RuntimeError("Unexpected response; check your regional API URL")
print(response.json())

A sikeres válasz a szervezetét adja vissza:

Response

{
  "id": "1e2f3a4b-5c6d-4e7f-8a9b-0c1d2e3f4a5b",
  "object": "organization",
  "name": "Example Corp",
  "region": "eu",
  "plan": "enterprise",
  "subscription_status": "active",
  "created_at": "2024-03-12T18:04:11.000Z"
}

Ha ezt a választ kapja, a hitelesítő adatai működnek. A kérés rövid időn belül megjelenik a Developer Hub Request logs lapján is.

A Bearer hitelesítés ugyanazzal a titkos értékkel (Authorization: Bearer lsk_live_...) szintén működik. A Basic auth azért létezik, hogy a csak felhasználónév/jelszó párost ismerő eszközök – például a Power BI Web connectora – is tudjanak csatlakozni.

A hitelesítés működése

A hitelesítő adat határozza meg a szervezetet. A /v1 kérések nem tartalmaznak bérlőválasztót: sem szervezeti útvonalszegmenst, sem szervezeti fejlécet. Az x-organization-id fejléc küldését a rendszer invalid_request hibával elutasítja. A gazdagépnek továbbra is egyeznie kell a szervezet régiójával. Lásd: Régiók.
A jogosultságok ellenőrzése műveletenként történik. Minden /v1 művelethez megnevezett jogosultság szükséges (például a GET /v1/organization a következőt igényli: organization:read). Ha a kulcsból hiányzik a jogosultság, 403 választ kap insufficient_permission kóddal.
A kulcsok lejárnak, és állásidő nélkül cserélhetők. Az átfedési időszakkal történő cseréről lásd az API-kulcsok című részt.

Hibaválaszok értelmezése

Minden /v1 hiba application/problem+json (RFC 9457) formátumú, stabil géppel olvasható kóddal. Például egy hiányzó vagy ismeretlen hitelesítő adattal küldött kérés a következőt adja vissza:

401 Unauthorized

{
  "type": "https://docs.livingsecurity.com/developers/v1/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "No valid API credential was provided.",
  "code": "unauthorized",
  "request_id": "req_...",
  "doc_url": "https://docs.livingsecurity.com/developers/v1/errors/unauthorized",
  "retryable": false
}

Az ágaztatást a code alapján végezze, soha ne a detail alapján. A megoldási lépésekért kövesse a doc_url hivatkozást, és az ügyfélszolgálat megkeresésekor adja meg a request_id értéket – ez egyezik a Request-Id válaszfejléccel és a Developer Hub kérésnaplóival. A teljes kódkészlet a hibahivatkozásban található.

Szerződésverziók

Minden válasz a kiszolgáló szerződésverzióját a Living-Security-Version fejlécben adja vissza, a korrelációhoz használt Request-Id fejléc mellett. A kérést dátum szerint rögzítheti egy közzétett szerződésverzióhoz:

curl --fail-with-body --connect-timeout 5 --max-time 30 \
  https://api.eu-west-1.livingsecurity.ai/v1/organization \
  -u "apikey:${LIVING_SECURITY_API_KEY:?Set LIVING_SECURITY_API_KEY}" \
  -H "Living-Security-Version: 2026-07-01"

A verzió feloldása ebben a sorrendben történik: a kérésfejléc, ha jelen van; egyébként a szolgáltatásfiók rögzített alapértelmezése; egyébként a legfrissebb közzétett verzió. Ha olyan verziót kér, amely nincs közzétéve (vagy lejárt a megszüntetési dátuma), a válasz 400 lesz unsupported_version kóddal. A közzétett verziók és azok változásai az API változásnaplóban találhatók.

Az első kérés hibaelhárítása

Eredmény	Következő lépés
`401 unauthorized`	Ellenőrizze a titkos értéket, annak lejáratát és a szervezet régióját. Éles hitelesítő adattal ne próbálkozzon más gazdagépekkel.
`403 insufficient_permission`	Adja meg a `organization:read` jogosultságot a szolgáltatásfióknak és a kulcsának is.
`400 unsupported_version`	Válasszon közzétett verziót a változásnaplóból.
`429 rate_limited`	Várjon a következőig: `Retry-After`; kövesse a korlátozott újrapróbálkozási példát.
Hálózati időtúllépés	Ellenőrizze a kapcsolatot, és az alkalmazás újrapróbálkozási keretén belül ismételje meg ezt a lekérdezést.

Egyéb hibák esetén kövesse a válasz doc_url mezőjét. Őrizze meg a Request-Id értéket az ügyfélszolgálat számára; soha ne tüntesse fel az Authorization fejlécet vagy az API-kulcsát a jegyben.

Következő lépések

Régiók

Válassza ki a szervezet számára az US vagy EU /v1 gazdagépet.

Lapozás

Járja be a listákat a page_token és a listaburkoló használatával.

Sebességkorlátok

Ismerje meg a kérési kereteket, és kezelje a 429 válaszokat.

Hibahivatkozás

Minden hibakód, a hozzá tartozó HTTP-állapot és a megoldás módja.

Developer Hub

Szolgáltatásfiókok, API-kulcsok és kérésnaplók kezelése.

Fejlesztői központ

Nyilvános API v1

API v1-referencia

Előfeltételek

Hitelesítő adatok létrehozása

A hitelesítés működése

Hibaválaszok értelmezése

Szerződésverziók

Az első kérés hibaelhárítása

Következő lépések

Régiók

Lapozás

Sebességkorlátok

Hibahivatkozás

Developer Hub

Fejlesztői központ

Nyilvános API v1

API v1-referencia

​Előfeltételek

​Hitelesítő adatok létrehozása

​A hitelesítés működése

​Hibaválaszok értelmezése

​Szerződésverziók

​Az első kérés hibaelhárítása

​Következő lépések

Régiók

Lapozás

Sebességkorlátok

Hibahivatkozás

Developer Hub

Előfeltételek

Hitelesítő adatok létrehozása

A hitelesítés működése

Hibaválaszok értelmezése

Szerződésverziók

Az első kérés hibaelhárítása

Következő lépések