APIt
APIen yleiskatsaus
SDA tarjoaa täysin käytettävissä olevan, modernin API-kerroksen, jonka avulla voit integroida, automatisoida ja laajentaa alustan kaikkia osia. Lähes kaikki SDA-alustan ominaisuudet – mukaan lukien laitehallinta, projektitoiminnot, putkien suoritus, identiteetinhallinta ja etäsuunnittelu – ovat käytettävissä turvallisten ja versioitujen APIen kautta. Näin asiakkaat voivat rakentaa omia työnkulkuja, automatisoida suunnitteluprosesseja ja integroida SDA:n olemassa oleviin yritysjärjestelmiin ja työkaluketjuihin.
Tässä osiossa dokumentoidaan SDA:n keskeiset APIt ja tarjotaan käytännön esimerkkejä, joiden avulla pääset nopeasti alkuun. Koodiesimerkit on toteutettu yleisillä kielillä, kuten Pythonilla, ja mallit ovat mukautettavissa JavaScriptiin, C#:iin ja muihin ympäristöihin tarpeen mukaan.
Keskeiset API-luokat
Asset API
Asset API tarjoaa ohjelmallisen pääsyn laitteisiin, projekteihin, resurssiryhmiin ja niihin liittyviin metatietoihin. Se mahdollistaa ulkoisille järjestelmille SDA:n resurssien listaamisen, kyselyn, päivittämisen ja orkestroinnin, mikä tekee siitä ideaalisen CMDB-synkronointiin, resurssien automatisoituun käyttöönottoon ja dataohjattuun resurssien elinkaaren hallintaan.
Job API
Job API mahdollistaa operatiivisten tehtävien, kuten varmuuskopioiden, käyttöönottojen, tilannevedosten, salasanojen kierrätysten ja muiden putkitoimintojen, käynnistämisen, seurannan ja hallinnan. Sitä käytetään yleisesti CI/CD-tyyliseen automaatioon, öisiin varmuuskopioihin sekä integrointiin tikettien tai työnkulkujärjestelmien kanssa.
Identity API
Identity API tarjoaa pääsyn käyttäjä-, rooli- ja oikeustietoihin. Se tukee integrointia ulkoisiin identiteettijärjestelmiin, omia provisiointityönkulkuja sekä käyttöoikeuksiin ja RBAC-pohjaisiin toimintoihin liittyvää edistynyttä automaatiota.
IDEaaS API
IDEaaS API tuo saataville selainpohjaiset suunnitteluominaisuudet, jolloin ulkoiset työkalut tai orkestroijat voivat luoda suunnitteluistuntoja, avata automaatioprojekteja ja käyttää valmistajakohtaisia IDE-ympäristöjä etänä. Tämä mahdollistaa automatisoidut suunnitteluputket, etätyötilat ja syvän integroinnin olemassa oleviin DevOps- tai IT/OT-alustoihin.
Koodiesimerkit
Jotta SDA:n APIen integrointi omaan ympäristöösi olisi nopeaa, tämä osio sisältää käytännön esimerkkejä alusta loppuun. Esimerkit havainnollistavat, miten todennus tehdään, miten dataa haetaan, miten putkitoimintoja käynnistetään ja miten integrointi ulkoisiin sovelluksiin toteutetaan.
Jokainen esimerkki tuo esiin parhaita käytäntöjä, kuten tokenien hallinnan, virheenkäsittelyn, sivutuksen ja suositellut tietoturva-asetukset.