Ohjelmointirajapinnan hallintapalveluun tutustuminen
API-hallinta tarjoaa keskeisen toiminnon, jolla varmistetaan onnistunut ohjelmointirajapintaohjelma kehittäjien osallistumisen, liiketoiminnan merkityksellisten tietojen, analytiikan, suojauksen ja suojauksen kautta. Kukin ohjelmointirajapinta koostuu yhdestä tai useammasta toiminnosta, ja kukin ohjelmointirajapinta voidaan lisätä yhteen tai useampaan tuotteeseen. Jos haluat käyttää ohjelmointirajapintaa, kehittäjät tilaavat kyseisen ohjelmointirajapinnan sisältävän tuotteen. Tämän jälkeen he voivat kutsua ohjelmointirajapinnan toimintaa minkä tahansa käyttökäytäntöjen mukaisesti.
Ohjelmointirajapinnan hallintakomponentit
Azuren API-hallinta koostuu -ohjelmointirajapinnan yhdyskäytävästä, hallintatasostaja kehittäjäportaalin. Nämä komponentit ovat Azure-isännöityjä, ja niitä hallitaan oletusarvoisesti täysin. Ohjelmointirajapinnan hallinta on käytettävissä eri tasoilla, kapasiteetissa ja ominaisuuksissa on eroja.
ohjelmointirajapinnan yhdyskäytävän on päätepiste, joka:
- Hyväksyy API-kutsut ja reitittää ne asianmukaisiin taustalähetteihin
- Todentaa ohjelmointirajapinta-avaimet ja muut pyynnöillä esitetyt tunnistetiedot
- Pakottaa käyttökiintiöt ja hintarajoitukset
- Muuntaa käytäntölausekkeissa määritetyt pyynnöt ja vastaukset
- Tallentaa välimuistiin vastaukset vastausviiveen parantamiseksi ja taustapalveluiden kuormituksen pienentämiseksi
- Kirjaa lokit, mittarit ja jäljitystiedot valvontaa, raportointia ja vianmääritystä varten
hallintatason on hallintaliittymä, jossa määrität ohjelmointirajapinta-ohjelmasi. Sen avulla voit:
- Ohjelmointirajapinnan hallintapalvelun asetusten valmisteleminen ja määrittäminen
- Ohjelmointirajapintarakenteen määrittäminen tai tuominen
- Paketti-ohjelmointirajapinnat tuotteisiin
- Määritä ohjelmointirajapinnoille käytäntöjä, kuten kiintiöitä tai muunnoksia
- Merkityksellisten tietojen hankkiminen analytiikasta
- Käyttäjien hallinta
Developer Portal - on automaattisesti muodostettu, täysin mukautettava sivusto, joka sisältää ohjelmointirajapintojen dokumentaation. Kehittäjäportaalin avulla kehittäjät voivat:
- Ohjelmointirajapinnan dokumentaation lukeminen
- Ohjelmointirajapinnan kutsuminen vuorovaikutteisen konsolin kautta
- Luo tili ja tilaa ohjelmointirajapinta-avaimia
- Käytä analytiikkaa heidän omassa käytössään
- Lataa ohjelmointirajapinnan määritelmät
- Ohjelmointirajapinta-avainten hallinta
Tuotteet
Ohjelmointirajapinnat näkyvät kehittäjille tuotteissa. Ohjelmointirajapintojen hallinnassa tuotteilla on yksi tai useampi ohjelmointirajapinta, ja ne on määritetty otsikolla, kuvauksella ja käyttöehdoilla. Tuotteita voidaan Open:ssa tai Protected.:ssa. Suojatut tuotteet on tilattava, ennen kuin niitä voi käyttää, kun taas avoimia tuotteita voi käyttää ilman tilausta. Tilauksen hyväksyntä määritetään tuotetasolla, ja se voi joko edellyttää järjestelmänvalvojan hyväksyntää tai tulla hyväksytyksi automaattisesti.
Ryhmät
Ryhmien avulla hallitaan tuotteiden näkyvyyttä kehittäjille. Ohjelmointirajapinnan hallinnassa on seuraavat muuttumattomat järjestelmäryhmät:
- järjestelmänvalvojat : API-hallintapalvelun esiintymien hallinta ja kehittäjien käyttämien ohjelmointirajapintojen, toimintojen ja tuotteiden luominen. Azure-tilauksen järjestelmänvalvojat ovat tämän ryhmän jäseniä.
- kehittäjät – Todennettuja kehittäjäportaalin käyttäjiä, jotka luovat sovelluksia ohjelmointirajapintojen avulla. Kehittäjille myönnetään käyttöoikeus kehittäjäportaaliin ja niiden sovellusten luomiseen, jotka kutsuvat ohjelmointirajapinnan toimintoja.
- Vieraiden : Todentamattomat kehittäjäportaalin käyttäjät. Heille voidaan myöntää tietty vain luku -käyttöoikeus, kuten mahdollisuus tarkastella ohjelmointirajapintoja, mutta ei kutsua niitä.
Näiden järjestelmäryhmien lisäksi järjestelmänvalvojat voivat luoda mukautettuja ryhmiä tai käyttää ulkoisia ryhmiä liittyvissä Microsoft Entra -vuokraajissa.
Kehittäjät
Kehittäjät edustavat käyttäjätilejä API-hallintapalvelun esiintymässä. Järjestelmänvalvojat voivat luoda kehittäjiä tai kutsua heidät mukaan, tai he voivat rekisteröityä kehittäjäportaalista. Jokainen kehittäjä on yhden tai useamman ryhmän jäsen, ja he voivat tilata tuotteita, jotka antavat näkyvyyttä näille ryhmille.
Manifesti
Käytännöt ovat lausekkeiden kokoelma, jotka suoritetaan järjestyksessä ohjelmointirajapinnan pyynnöstä tai vastauksesta. Suosittuja lausekkeita ovat muotoilumuunnos XML:stä JSON-muotoon ja puhelunopeuden rajoittaminen kehittäjän saapuvien kutsujen määrän rajoittamiseksi, ja monia muita käytäntöjä on käytettävissä.
Käytäntölausekkeita voidaan käyttää määritearvoina tai tekstiarvoina missä tahansa ohjelmointirajapinnan hallintakäytännössä, ellei käytäntö määritä muuta. Jotkin käytännöt, kuten Ohjausobjektin työnkulku ja Määritä muuttujakäytännöt, perustuvat käytäntölausekkeisiin.
Käytäntöjä voidaan käyttää eri vaikutusalueissa tarpeidesi mukaan: yleiset (kaikki ohjelmointirajapinnat), tuote, tietty ohjelmointirajapinta tai ohjelmointirajapintatoiminto.