API SPEC · V1 · GADEVELOPER REFERENCE

    Izstrādātāju API

    REST API AML pārbaudei

    Integrējiet sankciju, PEP, noziedzības uzraudzības sarakstu, negatīvo mediju un KYB/UBO pārbaudi tieši savās klientu uzņemšanas, monitoringa un darījumu plūsmās. API ir aktīvs: autentificējieties ar API atslēgu un izsauciet to pašu pārbaudes dzinēju, ko izmanto portāls.

    API v1 ir aktīvs

    Galapunkti ir vispārēji pieejami ar API atslēgas autentifikāciju un līmeņiem piesaistītiem pieprasījumu ierobežojumiem. Izpētiet katru galapunktu interaktīvajā OpenAPI dokumentācijā /api/v1/docs.

    §01Ātrā sākšana

    01 / 05
    STEP 01

    1. Izveidojiet API atslēgu

    Izveidojiet ierobežotu API atslēgu savā panelī vai ģenerējiet to programmatiski, izmantojot sava konta bearer marķieri servera-servera pieprasījumiem.

    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. Palaidiet pirmo meklēšanu

    Iesniedziet vienību ar X-API-Key galveni. API atgriež meklēšanas ID, ko izgūstat pēc apstrādes pabeigšanas.

    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. Iesniedziet pakešu

    Nosūtiet CSV/XLSX failu, lai vienā uzdevumā pārbaudītu daudzas vienības, tad izgūstiet rindas vai eksportus, kad pakete ir pabeigta.

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

    §02Galvenie galapunkti

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    Izveidojiet pārbaudes pieprasījumu vienai vienībai. Atgriež meklēšanas ID un apstrādes statusu. Konta, pārklājuma un darbības galapunkti arī pieejami zem /api/v1.

    Autentifikācija: X-API-Key (search:write)

    EP 02ENDPOINT

    POST /api/v1/batch

    Iesniedziet CSV/XLSX failus liela apjoma pārbaudei, tad izgūstiet rindas vai eksportus, kad uzdevumi pabeigti.

    Autentifikācija: X-API-Key (batch:write)

    EP 03ENDPOINT

    POST /api/v1/keys

    Izveidojiet un pārvaldiet API akreditācijas datus ar ierobežotām atļaujām, līmenim atbilstošiem pieprasījumu ierobežojumiem un lietojuma uzskaiti.

    Autentifikācija: Bearer marķieris (konts)

    §03Kāpēc komandas izmanto API

    03 / 05
    • Viena integrācija sankciju, PEP, noziedzības uzraudzības sarakstu, negatīvo mediju un KYB/UBO pārbaudei
    • API atslēgas autentifikācija ar X-API-Key galveni, ar atļauju ierobežotām atslēgām minimālo tiesību piekļuvei
    • Līmeņiem piesaistīti pieprasījumu ierobežojumi ar lietojuma žurnalēšanu pārvaldībai un izmaksu kontrolei
    • Meklēšanas, pakešu, atslēgu, konta, pārklājuma un darbības galapunkti zem /api/v1
    • Interaktīva OpenAPI dokumentācija /api/v1/docs, kā arī mašīnlasāma OpenAPI shēma
    • Strukturēta izvade, piemērota revīzijas žurnāliem, lietu materiāliem un lejupējiem lēmumiem

    §05API BUJ

    05 / 05
    Q01

    Kā autentificēt API pieprasījumus?

    Pārbaudes pieprasījumi uz /api/v1/search un /api/v1/batch tiek autentificēti ar API atslēgu, ko nosūta X-API-Key galvenē. Izveidojiet atslēgas savā panelī vai programmatiski caur /api/v1/keys pēc autentifikācijas ar sava konta bearer marķieri.

    Q02

    Vai API ir vispārēji pieejams?

    Jā. API v1 ir aktīvs un vispārēji pieejams. Autentificējieties ar API atslēgu, izsauciet meklēšanas, pakešu un atslēgu pārvaldības galapunktus un izpētiet visu interaktīvajā OpenAPI dokumentācijā /api/v1/docs.

    Q03

    Vai varu ierobežot API atslēgas atļaujas?

    Jā. Atslēgas atbalsta tādas atļaujas kā search:read, search:write, batch:read un batch:write, lai jūs varētu nodrošināt minimālo tiesību piekļuvi katrai integrācijai.

    Q04

    Kādi pieprasījumu ierobežojumi tiek piemēroti?

    Pieprasījumu ierobežojumi tiek piešķirti pēc API līmeņa un piemēroti katrai API atslēgai atsevišķi — līmenis nosaka pieprasījumu caurlaidspēju, nevis rēķinu izrakstīšanu. Atbildes galvenēs iekļauts ierobežojums, atlikusī kvota un atiestatīšanas laika zīmogi, lai jūs varētu attiecīgi pielāgot pieprasījumu plūsmu.

    Q05

    Kur var ātri izmēģināt galapunktus?

    Izmantojiet interaktīvo dokumentāciju /api/v1/docs Swagger testēšanai un /api/v1/redoc uzziņas stila dokumentācijai. OpenAPI shēma ir pieejama /api/v1/openapi.json.