Vertex Flow OpenAPI
OpenAPI on web-pohjainen ohjelmistoarkkitehtuuri, joka nostaa tuotetiedon käytettävyyden uudelle tasolle. Se mahdollistaa ulkopuolisille ohjelmistokehittäjille tehokkaan ja standardin tavan rakentaa liityntöjä olemassaoleviin tietojärjestelmiin tai omia, kokonaan uusia applikaatioita, jotka reaaliaikaisesti hyödyntävät Vertex-tiedonhallintajärjestelmän monipuolista tietosisältöä. OpenAPI:n toteutus ja dokumentointi nojautuu OpenAPI 3.0 -standardin mukaiseen viitekehykseen ja sen kautta ohjelmistokehittäjä saa paitsi rajapinnan kuvaukset myös työkaluja omaan kehitystyöhönsä.
Rajapintakuvaukset (Postman)
Flow 2024 (ja vanhemmat)
Flow 2025
Uutta versiossa
Flow 2025 OpenAPI ja uudistunut käyttäjähallinta
Uutta käyttäjähallintajärjestelmää tukeva Flow OpenAPI:n rajapinnan versio 2.0 on julkaistu Flow-version 2025 myötä. Flow 2025 tukee aiempaa käyttäjän autentikointitapaa ja käyttöönotto ei siten vaadi integraatioiden osalta toimenpiteitä. Aiempaa rajapintaa (v. 1.x.x, palvelut /api/rest/v1/** polussa) ei enää jatkossa kehitetä ja uudet ominaisuudet julkistetaan uuden API version yhteyteen (v. 2.x.x, palvelut /api/rest/v2/** polussa).
Siirtyminen v. 2 mukaisten API-palvelujen käyttöön vaatii muutokset kirjautumiseen (login, access tokenin käsittely) ja palvelujen URI-polkujen muutokset (/api/rest/v1/** → /api/rest/v2/**).
OpenAPI login Flow 2024 (OpenAPI v. 1)
https://documenter.getpostman.com/view/3502772/2sAYQdkW3P#6087a92c-b3d3-487f-8348-c944026879f8
OpenAPI login Flow 2025 (OpenAPI v. 2)
https://documenter.getpostman.com/view/3502772/2sAYQdkW3P#6b4b7572-a9e2-4e98-8649-497c8767529a
Lisätietoja
- Postman API Client: https://www.getpostman.com/product/api-client
- OpenAPI Specification, Swagger: https://swagger.io/docs/specification/about/
