Org-API
Lue tunnuksen organisaatiometatiedot. Vain luku julkisessa API:ssa — organisaatioasetuksia (säilytys, SMS opt-in, KYB) hallitaan sovelluksen sisäisestä admin-pinnasta, jossa auditointiketju kaappaa kuka muutti mitä ja milloin.
Hae organisaatio
GET /api/v1/public/org — laajuus 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"
} | Kenttä | Tyyppi | Huomiot |
|---|---|---|
id | UUID | Pysyvä tunnuksen koko eliniän ajan. |
name | string | Näyttönimi. Näytetään kutsusähköposteissa ja PDF-raportin ylätunnisteessa. |
country | ISO 3166-1 alpha-2 | Määrittää oletuskielialueen ja KYB-lainkäyttöalueen. |
settings_jsonb | object | Vapaamuotoiset organisaatiotason asetukset (oletuskielialue, automaattitallennuksen kytkin jne.). Skeema on eteenpäin yhteensopiva — käsittele tuntemattomat avaimet informatiivisina. |
retention_days | int | null | Kuinka kauan Evidence-tavut säilytetään objektitallennuksessa ennen kuin elinkaarisäännöt poistavat ne. null = alustan oletus (7 vuotta eIDAS-yhteensopivissa käyttöönotoissa). |
sms_enabled | bool | Onko SMS-kutsutoimitus käytössä. Oletuksena false; opt-in admin-SMS-kortista. |
created_at | ISO 8601 | Organisaation luontiaikaleima. |
Yleiset virheet
| Tila | Koodi | Milloin |
|---|---|---|
| 403 | permission_denied | Tunnukselta puuttuu org:read. |
Huomiot
- Yksi organisaatio per tunnus. Jokainen julkisen API:n tunnus on rajattu täsmälleen yhteen organisaatioon; et välitä
org_id-arvoa — tunnus ratkaisee sen palvelinpuolella. - Ei kirjoituspintaa. Organisaatioasetusten muutokset kulkevat admin-käyttöliittymän kautta, jotta operaattorin henkilöllisyys ja syy voidaan auditoida. Julkinen API pysyy tässä tarkoituksella vain luku -tilassa.
- White-label. Logon ja värien mukauttamisen osalta katso Branding-API — se on kirjoitettava nurkka.