3 - API:n / Rajapinnan käyttäminen
tässä ohjeessa ja ohjeen alasivuilla kerrotaan, miten rajapintoja voi selailla, etsiä. Ohjeessa kuvataan mitä tietoja API:sta saa ja miten API voidaan ottaa käyttöön omassa sovelluskehityksessä tai integraatioissa.
1 Yleistä
API-gateway alusta muodostaa julkaistuista rajapinnoista katalogin, josta pääsee selaamaan API-gatewayn kautta käytettävissä olevia rajapintoja. Tässä ohjeessa kuvataan, miten katalogiin pääsee ja miten katalogissa voi tilata käyttöoikeutta haluamaansa rajapintaan.
2 API-gatewayn katalogi
Löydät API-gatewayn katalogin API-gateway alustasta. Osoite alustalle on https://api.helsinki.fi/ (tuotanto) ja https://api-test.it.helsinki.fi/ (testi). Osoitteet on avattu tällä hetkellä vain Helsingin yliopiston sisäverkkoon, Eduroam-verkkoon ja VPN-verkkoon.
2.1 API-gateway-etusivu
Etusivu näyttää tältä:
Navigaatio on ylälaidassa ja API:n käyttö alkaa siirtymällä 'API GALLERY':n puolelle.
2.2 Katalogi eli API Gallery
API-katalogissa voi selailla julkaistuja rajapintoja. Galleriassa on mahdollista myös etsiä rajapintoja haun avulla.
Kun haluttu rajapinta löytyy katalogista, voi API:a painamalla nähdä:
- Tiedot API:sta
- API:n liittyvä dokumentaatio
- API:n versio
- API:n endpoint osoite
- API:n omistaja
- API:n julkaisuajankohta
Lisäksi API:n osalta voi lähettää:
- Tukipyyntöjä API:n liittyen
Mikäli API:n haluaa käyttöön, tulee API tilata (subscribe) ja ennen tilausta tulee tallentaa sovellus, joka tilausta käyttää. Tämän sivun alasivuilla on kerrottu tilaamiseen liittyvät ohjeet.
Parasta ennen: 31.8.2021
Vastuunjako | |
|---|---|
Api Gateway alustan tekninen ylläpito | Tapio Piironen, Ismo Aulaskari, Saku Säisä |
Ohjeiden ylläpito | Tiina Silvonen, OHTU-ryhmä |
Pääkäyttäjä (pääsynhallinta) | SKVA-ryhmä |
API-hallinta alustan omistaja (tekninen) | Minna Harjuniemi |
API-hallintamallin omistaja (sisällöllinen) | Timo Kauramäki |