API:t
API:iden yleiskatsaus
SEW tarjoaa täysin käytettävissä olevan, modernin API-kerroksen, jonka avulla voitte integroida, automatisoida ja laajentaa alustan jokaista osaa. Lähes kaikki SEW-alustan ominaisuudet — mukaan lukien laitehallinta, projektitoiminnot, putkien suoritus, identiteetinhallinta ja etäsuunnittelu — ovat käytettävissä turvallisten, versioitujen API:iden kautta. Tämä mahdollistaa asiakkaille mukautettujen työnkulkujen rakentamisen, suunnitteluprosessien automatisoinnin sekä SEW:n integroinnin olemassa oleviin yritysjärjestelmiin ja työkaluketjuihin.
Tässä osiossa dokumentoidaan SEW:n keskeiset API:t ja tarjotaan käytännön esimerkkejä, joiden avulla pääsette nopeasti alkuun. Koodiesimerkit on toteutettu yleisillä kielillä, kuten Pythonilla, ja niiden mallit ovat tarvittaessa sovitettavissa JavaScriptiin, C#:iin ja muihin ympäristöihin.
Keskeiset API-kategoriat
Asset API
Asset API tarjoaa ohjelmallisen pääsyn laitteisiin, projekteihin, resurssiryhmiin ja niihin liittyviin metatietoihin. Se mahdollistaa ulkoisten järjestelmien listata, kysellä, päivittää ja orkestroida SEW:n sisäisiä kohteita, mikä tekee siitä ihanteellisen CMDB-synkronointiin, automatisoituun kohteiden käyttöönottoon ja dataohjattuun kohteiden elinkaaren hallintaan.
Job API
Job API:n avulla voitte käynnistää, valvoa ja hallita operatiivisia tehtäviä, kuten varmuuskopiointeja, käyttöönottoja, tilannevedoksia, salasanojen vaihtoja ja muita putkitoimintoja. Sitä käytetään yleisesti CI/CD-tyyliseen automaatioon, öisiin varmuuskopiointeihin sekä integrointiin tiketöinti- tai työnkulkujärjestelmiin.
Identity API
Identity API tarjoaa pääsyn käyttäjä-, rooli- ja käyttöoikeustietoihin. Se tukee integrointia ulkoisiin identiteettijärjestelmiin, mukautettuja provisiointityönkulkuja sekä käyttöoikeuksien ja RBAC-pohjaisten toimintojen edistynyttä automaatiota.
IDEaaS API
IDEaaS API tuo saataville selainpohjaiset suunnittelutoiminnot, joiden avulla ulkoiset työkalut tai orkestraattorit voivat luoda suunnitteluistuntoja, avata PLC-projekteja ja käyttää valmistajakohtaisia IDE-ympäristöjä etänä. Tämä mahdollistaa automatisoidut suunnitteluputket, etätyötilat sekä syvän integraation olemassa oleviin DevOps- tai IT/OT-alustoihin.
Koodiesimerkit
Jotta SEW-API:iden integrointi ympäristöönne olisi nopeaa, tämä osio sisältää käytännönläheisiä, päästä päähän -esimerkkejä. Esimerkit havainnollistavat, miten todennus tehdään, miten tietoja 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.