API Org
Διαβάστε τα μεταδεδομένα του οργανισμού του διαπιστευτηρίου. Μόνο για ανάγνωση στο δημόσιο API — οι ρυθμίσεις οργανισμού (διατήρηση, opt-in SMS, KYB) διαχειρίζονται από την εντός εφαρμογής επιφάνεια διαχείρισης, όπου η αλυσίδα ελέγχου καταγράφει ποιος άλλαξε τι + πότε.
Λήψη του οργανισμού
GET /api/v1/public/org — εύρος org:read
curl https://app.nexbasira.com/api/v1/public/org \
-H "Authorization: Bearer nb_sec_..." {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Acme Insurance",
"country": "FR",
"settings_jsonb": {
"default_locale": "fr",
"auto_record_sessions": false
},
"retention_days": 2555,
"sms_enabled": true,
"created_at": "2024-09-01T08:00:00Z"
} | Πεδίο | Τύπος | Σημειώσεις |
|---|---|---|
id | UUID | Σταθερό καθ' όλη τη διάρκεια ζωής του διαπιστευτηρίου. |
name | string | Εμφανιζόμενο όνομα. Εμφανίζεται στα email προσκλήσεων + στην κεφαλίδα της αναφοράς PDF. |
country | ISO 3166-1 alpha-2 | Καθορίζει την προεπιλεγμένη τοπική ρύθμιση + τη δικαιοδοσία KYB. |
settings_jsonb | object | Ελεύθερης μορφής προτιμήσεις σε επίπεδο οργανισμού (προεπιλεγμένη τοπική ρύθμιση, εναλλαγή αυτόματης εγγραφής κ.λπ.). Το σχήμα είναι συμβατό προς τα εμπρός — αντιμετωπίστε τα άγνωστα κλειδιά ως πληροφοριακά. |
retention_days | int | null | Πόσο διατηρούνται τα bytes των τεκμηρίων στην αποθήκευση αντικειμένων προτού οι κανόνες κύκλου ζωής τα εκκαθαρίσουν. null = προεπιλογή πλατφόρμας (7 έτη για συμβατές με eIDAS αναπτύξεις). |
sms_enabled | bool | Εάν είναι ενεργοποιημένη η παράδοση προσκλήσεων μέσω SMS. Προεπιλογή false· opt-in μέσω της κάρτας SMS του διαχειριστή. |
created_at | ISO 8601 | Χρονοσφραγίδα δημιουργίας οργανισμού. |
Συνήθη σφάλματα
| Κατάσταση | Κωδικός | Πότε |
|---|---|---|
| 403 | permission_denied | Το διαπιστευτήριο δεν διαθέτει org:read. |
Σημειώσεις
- Ένας οργανισμός ανά διαπιστευτήριο. Κάθε διαπιστευτήριο του δημόσιου API έχει εμβέλεια σε ακριβώς έναν οργανισμό· δεν περνάτε
org_id— το διαπιστευτήριο το επιλύει από την πλευρά του διακομιστή. - Χωρίς επιφάνεια εγγραφής. Οι μεταβολές στις ρυθμίσεις οργανισμού γίνονται μέσω του UI διαχείρισης ώστε η ταυτότητα + ο λόγος του χειριστή να μπορούν να ελεγχθούν. Το δημόσιο API παραμένει σκόπιμα μόνο για ανάγνωση εδώ.
- White-label. Για προσαρμογή λογοτύπου + χρώματος, δείτε το API Branding — εκεί βρίσκεται η εγγράψιμη γωνιά.