API SPEC · V1 · GADEVELOPER REFERENCE

    Arendaja API

    REST API AML kontrolliks

    Integreerige sanktsioonide, PEP, kriminaalsete jälgimisnimekirjade, negatiivse meedia ja KYB/UBO kontroll otse oma liitumise, seire ja tehingute töövoogudesse. API on töötav: autentige API-võtmega ja kutsuge sama kontrollimootorit, mida kasutab meie portaal.

    API v1 on töötav

    Lõpp-punktid on üldiselt kättesaadavad API-võtme autentimise ja tasemepõhiste päringulimiitidega. Uurige iga lõpp-punkti interaktiivses OpenAPI dokumentatsioonis aadressil /api/v1/docs.

    §01Alustamine

    01 / 05
    STEP 01

    1. Looge API-võti

    Looge piiritletud API-võti oma juhtpaneelilt või genereerige see programmiliselt oma konto kandja-tokeniga serveripoolsete päringute jaoks.

    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. Käivitage esimene otsing

    Esitage üksus X-API-Key päisega. API tagastab otsingu ID, mille abil hangite tulemuse pärast töötlemise lõppu.

    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. Esitage hulgipäring

    Saatke CSV/XLSX-fail paljude üksuste kontrollimiseks ühe tööga, seejärel hankige read või ekspordid, kui hulgitöö lõpeb.

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

    §02Põhilised lõpp-punktid

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    Loob kontrollipäringu ühe üksuse jaoks. Tagastab otsingu ID ja töötlemise oleku. Konto, katvuse ja tervisekontrolli lõpp-punktid on samuti saadaval /api/v1 all.

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

    EP 02ENDPOINT

    POST /api/v1/batch

    Esitage CSV/XLSX-failid suuremahuliseks kontrollimiseks, seejärel hankige read või ekspordid, kui tööd lõpevad.

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

    EP 03ENDPOINT

    POST /api/v1/keys

    Looge ja hallake API mandaate piiritletud õiguste, taseme järgi kohandatud päringulimiitide ja kasutuse jälgimisega.

    Autentimine: kandja-token (konto)

    §03Miks meeskonnad seda API-t kasutavad

    03 / 05
    • Üks integratsioon sanktsioonide, PEP, kriminaalsete jälgimisnimekirjade, negatiivse meedia ja KYB/UBO kontrollimiseks
    • API-võtme autentimine X-API-Key päise kaudu, õigustega piiritletud võtmed vähimate privileegide juurdepääsuks
    • Tasemepõhised päringulimiidid koos kasutuse logimisega juhtimise ja kulude kontrolli jaoks
    • Otsingu, hulgipäringu, võtmete, konto, katvuse ja tervisekontrolli lõpp-punktid /api/v1 all
    • Interaktiivne OpenAPI dokumentatsioon aadressil /api/v1/docs ja masinloetav OpenAPI skeem
    • Struktureeritud väljund, mis sobib auditilogideks, juhtumitoimikuteks ja allavoolu otsusteks

    §05API korduma kippuvad küsimused

    05 / 05
    Q01

    Kuidas autentida API-päringuid?

    Kontrollipäringud lõpp-punktidele /api/v1/search ja /api/v1/batch autenditakse API-võtmega, mis saadetakse X-API-Key päises. Looge võtmed oma juhtpaneelilt või programmiliselt /api/v1/keys kaudu pärast autentimist oma konto kandja-tokeniga.

    Q02

    Kas API on üldiselt kättesaadav?

    Jah. API v1 on töötav ja üldiselt kättesaadav. Autentige API-võtmega, kutsuge otsingu, hulgipäringu ja võtmehalduse lõpp-punkte ning uurige kõike interaktiivses OpenAPI dokumentatsioonis aadressil /api/v1/docs.

    Q03

    Kas saan piiritleda API-võtme õigusi?

    Jah. Võtmed toetavad õigusi nagu search:read, search:write, batch:read ja batch:write, nii et saate iga integratsiooni jaoks kehtestada vähimate privileegide juurdepääsu.

    Q04

    Millised päringulimiidid kehtivad?

    Päringulimiidid määratakse API-taseme järgi ja jõustatakse API-võtme kaupa — tase juhib päringute läbilaskevõimet, mitte arveldust. Vastuse päised sisaldavad limiiti, järelejäänud kvooti ja lähtestamise ajatempleid, nii et saate koormust õigel ajal vähendada.

    Q05

    Kus saan lõpp-punkte kiiresti testida?

    Kasutage interaktiivset dokumentatsiooni aadressil /api/v1/docs Swaggeri testimiseks ja /api/v1/redoc viitestiilis dokumentatsiooni jaoks. OpenAPI skeem on saadaval aadressil /api/v1/openapi.json.