API SPEC · V1 · GADEVELOPER REFERENCE

    API Forbairtheoirí

    API REST do scagadh AML

    Comhtháthaigh scagadh smachtbhannaí, PEP, liostaí faire coiriúla, droch-mheáin, agus KYB/UBO go díreach i do shreafaí ionduchtaithe, monatóireachta, agus idirbheart. Tá an API beo: fíordheimhnigh le heochair API agus glaoigh ar an inneall scagtha céanna a úsáideann an tairseach.

    Tá API v1 beo

    Tá críochphointí ar fáil go ginearálta le fíordheimhniú eochrach API agus teorainneacha rátaí de réir leibhéil. Déan iniúchadh ar gach críochphointe sa doiciméadú idirghníomhach OpenAPI ag /api/v1/docs.

    §01Tosú tapa

    01 / 05
    STEP 01

    1. Cruthaigh eochair API

    Cruthaigh eochair API raonach i do dheais, nó bain ceann as go ríomhchláraithe le comhartha bearer do chuntais le haghaidh iarratas freastalaí-go-freastalaí.

    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. Rith do chéad chuardach

    Cuir eintiteas isteach leis an gceanntásc X-API-Key. Fillfidh an API aitheantas cuardaigh a aisghabhálann tú nuair a chríochnaíonn an phróiseáil.

    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. Cuir isteach baisc

    Seol comhad CSV/XLSX chun go leor eintiteas a scagadh in aon phost amháin, ansin aisghabháil sraitheanna nó easpórtálacha nuair a chríochnaíonn an bhaisc.

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

    §02Príomhchríochphointí

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    Cruthaigh iarratas scagtha d'aon eintiteas amháin. Fillfidh sé aitheantas cuardaigh agus stádas próiseála. Tá críochphointí cuntais, clúdaigh agus sláinte ar fáil freisin faoi /api/v1.

    Fíordheimhniú: X-API-Key (search:write)

    EP 02ENDPOINT

    POST /api/v1/batch

    Cuir isteach comhaid CSV/XLSX le haghaidh scagadh ar mhórimleabhar, ansin aisghabháil sraitheanna nó easpórtálacha nuair a chríochnaíonn poist.

    Fíordheimhniú: X-API-Key (batch:write)

    EP 03ENDPOINT

    POST /api/v1/keys

    Cruthaigh agus bainistigh dintiúir API le ceadanna raonacha, teorainneacha rátaí atá ar an eolas faoi leibhéal, agus rianú úsáide.

    Fíordheimhniú: Comhartha Bearer (cuntas)

    §03Cén fáth a n-úsáideann foirne an API

    03 / 05
    • Comhtháthú aonair le haghaidh scagadh smachtbhannaí, PEP, liostaí faire coiriúla, droch-mheáin, agus KYB/UBO
    • Fíordheimhniú eochrach API tríd an gceanntásc X-API-Key, le heochracha ceadanna-raonacha do rochtain leas-íosta
    • Teorainneacha rátaí de réir leibhéil le logáil úsáide le haghaidh rialachais agus rialú costais
    • Críochphointí cuardaigh, baisce, eochracha, cuntais, clúdaigh agus sláinte faoi /api/v1
    • Doiciméadú idirghníomhach OpenAPI ag /api/v1/docs móide scéimre OpenAPI inléite ag meaisín
    • Aschur struchtúrtha atá oiriúnach do logaí iniúchta, comhaid chásanna, agus cinntí iartheachtacha

    §05Ceisteanna Coitianta faoin API

    05 / 05
    Q01

    Conas a fhíordheimhním iarratais API?

    Fíordheimhníonn iarratais scagtha chuig /api/v1/search agus /api/v1/batch le heochair API a sheoltar sa cheanntásc X-API-Key. Cruthaigh eochracha i do dheais, nó go ríomhchláraithe trí /api/v1/keys tar éis duit fíordheimhniú le comhartha bearer do chuntais.

    Q02

    An bhfuil an API ar fáil go ginearálta?

    Tá. Tá API v1 beo agus ar fáil go ginearálta. Fíordheimhnigh le heochair API, glaoigh ar na críochphointí cuardaigh, baisce agus bainistíochta eochracha, agus déan iniúchadh ar gach rud sa doiciméadú idirghníomhach OpenAPI ag /api/v1/docs.

    Q03

    An féidir liom ceadanna eochrach API a raonú?

    Is féidir. Tacaíonn eochracha le ceadanna ar nós search:read, search:write, batch:read, agus batch:write ionas gur féidir leat rochtain leas-íosta a fhorfheidhmiú in aghaidh gach comhtháthaithe.

    Q04

    Cé na teorainneacha rátaí a bhaineann?

    Sanntar teorainneacha rátaí de réir leibhéil API agus forfheidhmítear iad in aghaidh gach eochrach API — rialaíonn an leibhéal trádghluaiseacht na n-iarratas, ní an billeáil. Áirítear i gceanntásca freagartha an teorainn, an cuóta atá fágtha, agus stampaí ama athshocraithe ionas gur féidir leat maolú go glan.

    Q05

    Cá háit ar féidir liom na críochphointí a thástáil go tapa?

    Úsáid an doiciméadú idirghníomhach ag /api/v1/docs le haghaidh tástáil Swagger agus /api/v1/redoc le haghaidh doiciméadú stíl-tagartha. Freastalaítear an scéimre OpenAPI ag /api/v1/openapi.json.