REST API

Integration-deploymentit julkaisevat REST API:n, joka kattaa nykyiset VeraFrame-ominaisuudet integroidussa käytössä: validointi ja generointi, dokumenttipohjat, source groupit, historia, audit-exportit ja tenantin admin-toiminnot.

Base URL

https://<your-deployment>.veraframe.io/api/v1

Autentikointi

Bearer token

Saatu joko paikallisesta loginista tai deploymentin omasta OIDC/JWT-flow’sta.

Authorization: Bearer <token>

Enterprise JWT/OIDC -deploymenteissa token voi sisältää myös:

VeraFrame app-role mappingin — esimerkiksi asiakkaan vf_admins mappautuu VeraFramen admin-rooliin
data-access-roolit — joilla päätellään mitä source groupeja käyttäjä saa käyttää

API key

Service-to-service-käyttöön ilman loppukäyttäjän bearer-tokenia:

{
  "customer_id": "your-tenant-id",
  "api_key": "..."
}

Yhtenäinen `/validate`

POST /api/v1/validate

mode valitsee käyttäytymisen:

validate
generate
validate_and_fix

Source material tulee source groupeista, inline-tekstistä tai URL:ista.

Templates

POST /api/v1/templates
POST /api/v1/templates/{id}
POST /api/v1/templates/upload-url
POST /api/v1/templates/{id}/scan
POST /api/v1/templates/{id}/save
POST /api/v1/templates/{id}/delete

Source groups

POST /api/v1/sources
POST /api/v1/sources/upload-url
POST /api/v1/sources/group/save
POST /api/v1/sources/group/delete
POST /api/v1/sources/file/delete

POST /api/v1/sources/group/save tukee nykyisiä access-control-kenttiä:

allowed_roles — lista identity-providerin rooleista tai claimeista, joilla ryhmää saa käyttää
API-backed endpointteihin endpoints[].authz_forwarding, jolla säädetään välitetäänkö:
- user_id
- customer_id
- data_access_roles
- original_jwt

Jos allowed_roles puuttuu tai on tyhjä, ryhmä on sallittu kaikille.

Source group -enforcement

Kun /validate käyttää source_groups-listaa, VeraFrame enforceaa rajoitukset server-side ennen retrievaliä:

sallitut ryhmät haetaan normaalisti
kielletyt ryhmät ohitetaan
response-metadata voi kertoa, että source accessia suodatettiin

Pyynnön bodyssa annettu kielletty source group ei siis ohita rajoitusta.

Downstream REST API -kontekstin forwarding

API-backed source groupeille VeraFrame voi optionaalisesti välittää:

X-VeraFrame-User-Id
X-VeraFrame-Customer-Id
X-VeraFrame-Data-Access-Roles
X-VeraFrame-Original-JWT

Tämä forwarding on endpoint-kohtainen ja oletuksena pois päältä. Se ei korvaa VeraFramen inbound-authia eikä downstream-palvelun omaa teknistä autentikointia.

Tämä on myös suositeltu malli silloin, kun organisaatio tarvitsee document- tai record-tasolla hienojakoisempaa oikeuksien hallintaa kuin mitä VeraFramen omat source group -rajoitukset tarjoavat:

VeraFrame päättää, saako kutsuja käyttää source groupia ylipäätään.
Downstream REST API päättää, saako sama käyttäjä nähdä juuri kyseisen dokumentin, casen, sopimuksen tai tietueen.

Toisin sanoen VeraFrame myötäilee asiakkaan olemassa olevaa oikeuksienhallintamallia eikä pyri korvaamaan sitä omalla kerroksellaan.

History, analytics, audit

POST /api/v1/history
POST /api/v1/history/{id}/review
POST /api/v1/stats
POST /api/v1/analytics
POST /api/v1/analytics/csv
POST /api/v1/audit
POST /api/v1/audit/export
POST /api/v1/system-card