API SPEC · V1 · GADEVELOPER REFERENCE

    Fejlesztői API

    REST API az AML-szűréshez

    Illessze be a szankciós, PEP-, bűnügyi figyelőlista-, negatívmédia- és KYB/UBO-szűrést közvetlenül ügyfél-befogadási, monitorozási és tranzakciós folyamataiba. Az API élesben fut: hitelesítsen egy API-kulccsal, és hívja ugyanazt a szűrőmotort, amelyet a portál is használ.

    Az API v1 élesben fut

    A végpontok általánosan elérhetők API-kulcsos hitelesítéssel és szintenkénti sebességkorlátokkal. Fedezzen fel minden végpontot az interaktív OpenAPI-dokumentációban a /api/v1/docs címen.

    §01Gyorsindítás

    01 / 05
    STEP 01

    1. API-kulcs létrehozása

    Hozzon létre egy hatáskörhöz kötött API-kulcsot a vezérlőpultján, vagy generáljon egyet programozottan a fiókjához tartozó bearer tokennel szerver-szerver kérésekhez.

    curl
    curl -X POST https://screenveritai.com/api/v1/keys \
      -H "Authorization: Bearer <SUPABASE_JWT>" \
      -H "Content-Type: application/json" \
      -d '{"name":"server-key","permissions":["search:read","search:write"]}'
    STEP 02

    2. Futtassa első keresését

    Küldjön be egy szervezetet az X-API-Key fejléccel. Az API visszaad egy search id-t, amelyet a feldolgozás befejeztével lekérdezhet.

    curl
    curl -X POST https://screenveritai.com/api/v1/search \
      -H "X-API-Key: <YOUR_API_KEY>" \
      -H "Content-Type: application/json" \
      -d '{"entity_name":"Acme Ltd","entity_type":"company","search_type":"full_search"}'
    STEP 03

    3. Küldjön be egy köteget

    Küldjön egy CSV/XLSX fájlt, hogy egyetlen feladatban sok szervezetet szűrjön, majd kérdezze le a sorokat vagy exportokat, amikor a köteg befejeződött.

    curl
    curl -X POST https://screenveritai.com/api/v1/batch \
      -H "X-API-Key: <YOUR_API_KEY>" \
      -F "file=@entities.csv"

    §02Alapvető végpontok

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    Szűrési kérés létrehozása egyetlen szervezethez. Visszaad egy search id-t és feldolgozási állapotot. Fiók-, lefedettségi és állapotellenőrző végpontok is elérhetők a /api/v1 alatt.

    Hitelesítés: X-API-Key (search:write)

    EP 02ENDPOINT

    POST /api/v1/batch

    CSV/XLSX fájlok beküldése nagy volumenű szűréshez, majd sorok vagy exportok lekérdezése a feladatok befejezésekor.

    Hitelesítés: X-API-Key (batch:write)

    EP 03ENDPOINT

    POST /api/v1/keys

    API-hitelesítő adatok létrehozása és kezelése hatáskörhöz kötött jogosultságokkal, szintfüggő sebességkorlátokkal és használatkövetéssel.

    Hitelesítés: Bearer token (fiók)

    §03Miért használják a csapatok az API-t

    03 / 05
    • Egyetlen integráció szankciós, PEP-, bűnügyi figyelőlista-, negatívmédia- és KYB/UBO-szűréshez
    • API-kulcsos hitelesítés az X-API-Key fejlécen keresztül, hatáskörhöz kötött kulcsokkal a legkisebb jogosultság elve alapján
    • Szintfüggő sebességkorlátok használatnaplózással a szabályozáshoz és a költségkontrollhoz
    • Kereső-, tömeges, kulcs-, fiók-, lefedettségi és állapotellenőrző végpontok a /api/v1 alatt
    • Interaktív OpenAPI-dokumentáció a /api/v1/docs címen, plusz géppel olvasható OpenAPI-séma
    • Strukturált kimenet, amely alkalmas audit naplókhoz, ügyaktákhoz és további döntésekhez

    §05API GYIK

    05 / 05
    Q01

    Hogyan hitelesítem az API-kéréseket?

    A /api/v1/search és /api/v1/batch szűrési kérések az X-API-Key fejlécben küldött API-kulccsal hitelesítenek. Hozzon létre kulcsokat a vezérlőpultján, vagy programozottan a /api/v1/keys végponton keresztül, miután hitelesítette magát a fiókjához tartozó bearer tokennel.

    Q02

    Az API általánosan elérhető?

    Igen. Az API v1 élesben fut, és általánosan elérhető. Hitelesítsen egy API-kulccsal, hívja a kereső-, tömeges és kulcskezelő végpontokat, és fedezzen fel mindent az interaktív OpenAPI-dokumentációban a /api/v1/docs címen.

    Q03

    Beállíthatom az API-kulcsok jogosultsági hatáskörét?

    Igen. A kulcsok olyan jogosultságokat támogatnak, mint a search:read, search:write, batch:read és batch:write, így integrációnként érvényesítheti a legkisebb jogosultság elvét.

    Q04

    Milyen sebességkorlátok érvényesek?

    A sebességkorlátokat API-szint szerint rendeljük hozzá, és API-kulcsonként érvényesítjük — a szint a kérések átviteli sebességét szabályozza, nem a számlázást. A válaszfejlécek tartalmazzák a korlátot, a fennmaradó kvótát és a visszaállítási időbélyeget, így tisztán tud visszaállni.

    Q05

    Hol tesztelhetem gyorsan a végpontokat?

    Használja az interaktív dokumentációt a /api/v1/docs címen Swagger-teszteléshez, és a /api/v1/redoc oldalt referencia jellegű dokumentációhoz. Az OpenAPI-sémát a /api/v1/openapi.json cím szolgáltatja.