API SPEC · V1 · GADEVELOPER REFERENCE

    Kūrėjų API

    REST API AML patikrai

    Integruokite sankcijų, PEP, kriminalinių sąrašų, neigiamos žiniasklaidos (angl. „adverse media“) ir KYB/UBO patikrą tiesiai į kliento priėmimo, stebėsenos ir sandorių eigas. API jau veikia: autentifikuokitės API raktu ir kvieskite tą patį patikros variklį, kurį naudoja portalas.

    API v1 jau veikia

    Galiniai taškai yra visuotinai prieinami su API rakto autentifikacija ir pakopinėmis užklausų ribomis. Kiekvieną galinį tašką išbandykite interaktyvioje OpenAPI dokumentacijoje adresu /api/v1/docs.

    §01Greita pradžia

    01 / 05
    STEP 01

    1. Sukurkite API raktą

    Sukurkite apribotų teisių API raktą valdymo skydelyje arba sugeneruokite jį programiškai su paskyros bearer žetonu serveris–serveris užklausoms.

    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. Atlikite pirmą paiešką

    Pateikite subjektą su X-API-Key antrašte. API grąžina paieškos ID, kurį atsiimate, kai apdorojimas baigiamas.

    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. Pateikite masinę užduotį

    Nusiųskite CSV/XLSX failą, kad viena užduotimi patikrintumėte daug subjektų, o pasibaigus masinei patikrai atsiimkite eilutes ar eksportą.

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

    §02Pagrindiniai galiniai taškai

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    Sukuria vieno subjekto patikros užklausą. Grąžina paieškos ID ir apdorojimo būseną. Paskyros, aprėpties ir būklės galiniai taškai taip pat pasiekiami po /api/v1.

    Autentifikacija: X-API-Key (search:write)

    EP 02ENDPOINT

    POST /api/v1/batch

    Pateikite CSV/XLSX failus didelės apimties patikrai, o pasibaigus užduotims atsiimkite eilutes ar eksportą.

    Autentifikacija: X-API-Key (batch:write)

    EP 03ENDPOINT

    POST /api/v1/keys

    Kurkite ir tvarkykite API prisijungimo duomenis su apribotomis teisėmis, pagal pakopą taikomomis užklausų ribomis ir naudojimo stebėjimu.

    Autentifikacija: Bearer žetonas (paskyra)

    §03Kodėl komandos renkasi API

    03 / 05
    • Viena integracija sankcijų, PEP, kriminalinių sąrašų, neigiamos žiniasklaidos ir KYB/UBO patikrai
    • API rakto autentifikacija per X-API-Key antraštę su teisėmis apribotais raktais mažiausios privilegijos prieigai
    • Pagal pakopą taikomos užklausų ribos su naudojimo registravimu valdysenai ir išlaidų kontrolei
    • Paieškos, masinės patikros, raktų, paskyros, aprėpties ir būklės galiniai taškai po /api/v1
    • Interaktyvi OpenAPI dokumentacija adresu /api/v1/docs ir mašininiu būdu nuskaitoma OpenAPI schema
    • Struktūrizuota išvestis, tinkama audito žurnalams, bylų dokumentacijai ir tolesniems sprendimams

    §05API DUK

    05 / 05
    Q01

    Kaip autentifikuoti API užklausas?

    Patikros užklausos į /api/v1/search ir /api/v1/batch autentifikuojamos API raktu, siunčiamu X-API-Key antraštėje. Raktus kurkite valdymo skydelyje arba programiškai per /api/v1/keys, prieš tai autentifikavęsi paskyros bearer žetonu.

    Q02

    Ar API yra visuotinai prieinamas?

    Taip. API v1 jau veikia ir yra visuotinai prieinamas. Autentifikuokitės API raktu, kvieskite paieškos, masinės patikros ir raktų valdymo galinius taškus bei viską išbandykite interaktyvioje OpenAPI dokumentacijoje adresu /api/v1/docs.

    Q03

    Ar galiu apriboti API rakto teises?

    Taip. Raktai palaiko tokias teises kaip search:read, search:write, batch:read ir batch:write, kad galėtumėte kiekvienai integracijai užtikrinti mažiausios privilegijos prieigą.

    Q04

    Kokios užklausų ribos taikomos?

    Užklausų ribos priskiriamos pagal API pakopą ir taikomos kiekvienam API raktui — pakopa nustato užklausų pralaidumą, o ne apmokestinimą. Atsakymo antraštėse pateikiama riba, likusi kvota ir atkūrimo laiko žymos, kad galėtumėte tvarkingai sulėtinti užklausas.

    Q05

    Kur galiu greitai išbandyti galinius taškus?

    Naudokitės interaktyvia dokumentacija adresu /api/v1/docs (Swagger bandymams) ir /api/v1/redoc (žinyno tipo dokumentacija). OpenAPI schema pateikiama adresu /api/v1/openapi.json.