API SPEC · V1 · GADEVELOPER REFERENCE

    API προγραμματιστών

    REST API για έλεγχο AML

    Ενσωματώστε τον έλεγχο κυρώσεων, PEP, ποινικής παρακολούθησης, δυσμενών μέσων και KYB/UBO απευθείας στις ροές ένταξης πελατών, παρακολούθησης και συναλλαγών σας. Το API είναι ζωντανό: αυθεντικοποιηθείτε με κλειδί API και καλέστε την ίδια μηχανή ελέγχου που χρησιμοποιεί η πλατφόρμα.

    Το API v1 είναι διαθέσιμο

    Τα endpoints είναι γενικά διαθέσιμα με αυθεντικοποίηση μέσω κλειδιού API και όρια ρυθμού ανά πρόγραμμα. Εξερευνήστε κάθε endpoint στη διαδραστική τεκμηρίωση OpenAPI στο /api/v1/docs.

    §01Γρήγορη εκκίνηση

    01 / 05
    STEP 01

    1. Δημιουργήστε κλειδί API

    Δημιουργήστε ένα κλειδί API με καθορισμένο εύρος δικαιωμάτων από τον πίνακα ελέγχου σας, ή δημιουργήστε ένα προγραμματιστικά με το bearer token του λογαριασμού σας για αιτήματα διακομιστή προς διακομιστή.

    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. Εκτελέστε την πρώτη σας αναζήτηση

    Υποβάλετε μια οντότητα με την κεφαλίδα X-API-Key. Το API επιστρέφει ένα αναγνωριστικό αναζήτησης που ανακτάτε όταν ολοκληρωθεί η επεξεργασία.

    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. Υποβάλετε μαζική εργασία

    Στείλτε ένα αρχείο CSV/XLSX για να ελέγξετε πολλές οντότητες σε μία εργασία, και ανακτήστε γραμμές ή εξαγωγές μόλις ολοκληρωθεί η μαζική εργασία.

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

    §02Βασικά endpoints

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    Δημιουργεί αίτημα ελέγχου για μία οντότητα. Επιστρέφει αναγνωριστικό αναζήτησης και κατάσταση επεξεργασίας. Διατίθενται επίσης endpoints λογαριασμού, κάλυψης και κατάστασης λειτουργίας κάτω από το /api/v1.

    Αυθεντικοποίηση: X-API-Key (search:write)

    EP 02ENDPOINT

    POST /api/v1/batch

    Υποβάλετε αρχεία CSV/XLSX για έλεγχο μεγάλου όγκου, και ανακτήστε γραμμές ή εξαγωγές όταν ολοκληρωθούν οι εργασίες.

    Αυθεντικοποίηση: X-API-Key (batch:write)

    EP 03ENDPOINT

    POST /api/v1/keys

    Δημιουργήστε και διαχειριστείτε διαπιστευτήρια API με καθορισμένο εύρος δικαιωμάτων, όρια ρυθμού ανά πρόγραμμα και παρακολούθηση χρήσης.

    Αυθεντικοποίηση: Bearer token (λογαριασμός)

    §03Γιατί οι ομάδες χρησιμοποιούν το API

    03 / 05
    • Μία ενσωμάτωση για έλεγχο κυρώσεων, PEP, ποινικής παρακολούθησης, δυσμενών μέσων και KYB/UBO
    • Αυθεντικοποίηση μέσω κλειδιού API με την κεφαλίδα X-API-Key, με κλειδιά περιορισμένων δικαιωμάτων για πρόσβαση ελάχιστου προνομίου
    • Όρια ρυθμού ανά πρόγραμμα με καταγραφή χρήσης για διακυβέρνηση και έλεγχο κόστους
    • Endpoints αναζήτησης, μαζικού ελέγχου, κλειδιών, λογαριασμού, κάλυψης και κατάστασης λειτουργίας κάτω από το /api/v1
    • Διαδραστική τεκμηρίωση OpenAPI στο /api/v1/docs, μαζί με αναγνώσιμο από μηχανή σχήμα OpenAPI
    • Δομημένη έξοδος κατάλληλη για αρχεία ελέγχου, φακέλους υποθέσεων και αποφάσεις επόμενου σταδίου

    §05Συχνές ερωτήσεις για το API

    05 / 05
    Q01

    Πώς αυθεντικοποιώ τα αιτήματα API;

    Τα αιτήματα ελέγχου προς /api/v1/search και /api/v1/batch αυθεντικοποιούνται με κλειδί API που στέλνεται στην κεφαλίδα X-API-Key. Δημιουργήστε κλειδιά από τον πίνακα ελέγχου σας, ή προγραμματιστικά μέσω του /api/v1/keys αφού αυθεντικοποιηθείτε με το bearer token του λογαριασμού σας.

    Q02

    Είναι το API γενικά διαθέσιμο;

    Ναι. Το API v1 είναι ζωντανό και γενικά διαθέσιμο. Αυθεντικοποιηθείτε με κλειδί API, καλέστε τα endpoints αναζήτησης, μαζικού ελέγχου και διαχείρισης κλειδιών, και εξερευνήστε τα όλα στη διαδραστική τεκμηρίωση OpenAPI στο /api/v1/docs.

    Q03

    Μπορώ να περιορίσω τα δικαιώματα ενός κλειδιού API;

    Ναι. Τα κλειδιά υποστηρίζουν δικαιώματα όπως search:read, search:write, batch:read και batch:write, ώστε να επιβάλλετε πρόσβαση ελάχιστου προνομίου ανά ενσωμάτωση.

    Q04

    Ποια όρια ρυθμού ισχύουν;

    Τα όρια ρυθμού καθορίζονται ανά επίπεδο API και επιβάλλονται ανά κλειδί API — το επίπεδο διέπει τη ροή αιτημάτων, όχι τη χρέωση. Οι κεφαλίδες απόκρισης περιλαμβάνουν το όριο, το εναπομένον ποσοστό και τη χρονοσήμανση επαναφοράς, ώστε να μπορείτε να προσαρμόσετε τον ρυθμό των αιτημάτων σας ομαλά.

    Q05

    Πού μπορώ να δοκιμάσω γρήγορα τα endpoints;

    Χρησιμοποιήστε τη διαδραστική τεκμηρίωση στο /api/v1/docs για δοκιμές Swagger και το /api/v1/redoc για τεκμηρίωση τύπου αναφοράς. Το σχήμα OpenAPI εξυπηρετείται στο /api/v1/openapi.json.