Megosztás a következőn keresztül:

Az App Center API dokumentációja

Fontos

A Visual Studio App Center 2025. március 31-én megszűnt, kivéve az Elemzési és diagnosztikai funkciókat, amelyek 2026. június 30-ig továbbra is támogatottak lesznek. Tudj meg többet.

Az App Center OpenAPI specifikációja (Swagger)

Az App Center api-végpontok teljes készletét teszi elérhetővé. Az App Center API-t az App Center OpenAPI specifikációja segítségével ismerheti meg.

Az App Center OpenAPI specifikációja lehetővé teszi a hitelesítést az API-jogkivonat használatával. A hitelesítés után meghívhatja az App Center API-kat, hogy megismerje az API-t, és megtudja, milyen adatokat ad vissza.

Jogkivonatok típusai: felhasználói jogkivonatok és alkalmazásjogkivonatok

Az App Center kétféle API-jogkivonatot tesz elérhetővé: felhasználói jogkivonatokat és alkalmazásjogkivonatokat.

A felhasználói API-jogkivonatok ugyanazokkal a jogosultságokkal rendelkeznek, mint az App Center felhasználói. Felhasználói API-jogkivonatok minden szervezetnél és alkalmazásnál működnek, amellyel kapcsolatban áll.

Az alkalmazás API-jogkivonatok kezelői vagy megtekintői jogosultságokkal rendelkeznek, de csak egy alkalmazáson belül.

Minden App Center-fiók legfeljebb 5000 API-jogkivonatot hozhat létre.

Jótanács

Javasoljuk, hogy hozzon létre és használjon App API-jogkivonatokat, hogy az engedélyezési hatókört egyszerre csak egy alkalmazásra korlátozza (és korlátozza a kockázatot, ha egy jogkivonat megjelenik). Ha egy alkalmazáson kívül is automatizálnia kell valamit, például szervezetekkel vagy megosztott terjesztési csoportokkal kell dolgoznia, létre kell hoznia egy Felhasználói API-jogkivonatot.

Figyelmeztetés

Ne ágyazza be az API-jogkivonatokat a forráskódba. Az API-jogkivonatokat titkos kódként kell kezelni, és biztonságosan kell tárolni.

Figyelmeztetés

A kérésnek tartalmaznia kell egy hasznos adattörzset a POST/PUT/PATCH API-hívásokhoz. Ha üres hasznos adattörzset használ {} , az API-hívások 411 hosszúságú kötelező hibaüzenetet kapnak, ellenkező esetben.

App Center App API-jogkivonat létrehozása

  1. Lépjen a https://appcenter.ms oldalra, és jelentkezzen be fiókja hitelesítő adataival.

  2. Válassza ki azt az alkalmazást , amelyhez API-jogkivonatot szeretne létrehozni.

  3. A bal oldalon válassza a Beállítások lehetőséget.

  4. A középső panelen válassza az App API-jogkivonatokat a menülistában.

  5. A jobb felső sarokban kattintson az Új API-jogkivonatra.

  6. A szövegmezőbe írjon be egy leíró nevet a token számára.

  7. Válassza ki az App API-jogkivonathoz való hozzáférés típusát:

    Teljes hozzáférés: A teljes hozzáférésű App API-jogkivonat rendelkezik az adott alkalmazáshoz tartozó Manager-engedélyekkel. Csak a vezetők hozhatnak létre teljes hozzáférésű Alkalmazás API-jogkivonatokat.

    Írásvédett: Egy írásvédett Alkalmazás API-jogkivonat rendelkezik az adott alkalmazás megtekintői hozzáférési engedélyével. A vezetők és fejlesztők írásvédett alkalmazás API-jogkivonatokat hozhatnak létre.

  8. A panel alján kattintson az Új API-jogkivonat hozzáadása elemre.

  9. Egy előugró ablak nyílik meg az App API-jogkivonattal. Másolja és tárolja biztonságos helyen későbbi használatra. Biztonsági okokból a Bezárás gombra kattintás után nem láthatja és nem hozhatja létre újra ugyanazt a jogkivonatot.

  10. Kattintson a Bezárás gombra.

App Center Felhasználói API-jogkivonat létrehozása

  1. Lépjen a https://appcenter.ms oldalra, és jelentkezzen be fiókja hitelesítő adataival.

  2. Az App Center portál jobb felső sarkában kattintson a fiókavatárra, majd válassza a Fiókbeállítások lehetőséget.

  3. A középső panelen válassza a Felhasználói API-jogkivonatok lehetőséget a menülistában.

  4. A jobb felső sarokban kattintson az Új API-jogkivonatra.

  5. A szövegmezőbe írjon be egy leíró nevet a token számára.

  6. Válassza ki a felhasználói API-jogkivonathoz való hozzáférés típusát:

    Teljes hozzáférés: A teljes hozzáférésű felhasználói API-jogkivonat rendelkezik az aktuális fiók/szervezet összes engedélyével. Ha például nem rendelkezik kezelői vagy fejlesztői engedélyekkel egy alkalmazáshoz, a felhasználó nem tud teszteket futtatni, még akkor sem, ha teljes hozzáférésű felhasználói API-jogkivonatot használ.

    Írásvédett: Egy írásvédett felhasználói API azonosító megtekintési engedéllyel rendelkezik az aktuális fiókhoz/szervezethez. Például egy írásvédett felhasználói API-jogkivonattal adatokat olvashat az alkalmazás-összeomlásokról, analitikáról, és alapvető alkalmazásinformációkhoz juthat hozzá. A csak olvasható felhasználói API-jogkivonatok nem módosíthatják az alkalmazás beállításait, nem hozhatnak létre exportálási konfigurációt stb.

  7. A panel alján kattintson az Új API-jogkivonat hozzáadása elemre.

  8. A felhasználói API-jogkivonattal megnyílik egy előugró ablak. Másolja és tárolja biztonságos helyen későbbi használatra. Biztonsági okokból a Bezárás gombra kattintás után nem láthatja és nem hozhatja létre újra ugyanazt a jogkivonatot.

  9. Kattintson a Bezárás gombra.

API-jogkivonat használata API-kérésben

Amikor API-kéréseket küld az App Centernek egy alkalmazásból, az API-jogkivonatot az App Centernek küldött összes kérés fejlécében kell szerepeltetnie.

Adja át az API-jogkivonatot a kérelem fejléctulajdonságában X-API-Token .

Az App Center alkalmazás nevének és tulajdonosának megkeresése

Az App Center API-funkcióinak és parancssori felületének egyes kérései paraméterként alkalmazásnevet vagy tulajdonosnevet igényelnek.

Például a felhasználó alkalmazásból való eltávolítására szolgáló API-híváshoz a következőkre van szükség: DELETE /v0.1/apps/{owner_name}/{app_name}/users/{user_email}.

Az alkalmazás nevét és tulajdonosát az App Center URL-címéből vagy az App Center parancssori felületéről is megtalálhatja.

Keresse meg az owner_name-t és az app_name-t egy App Center URL-ből.

  1. Navigáljon ide: https://appcenter.ms.
  2. Lépjen be az alkalmazásba.
  3. Ha megtekinti az alkalmazás URL-címét, az formátuma https://appcenter.ms/users/{owner-name}/apps/{app-name}.

A tulajdonos lehet felhasználó vagy szervezet. Például:

Tulajdonos URL-cím Tulajdonos neve Alkalmazás neve
Felhasználó https://appcenter.ms/users/AlexLerxst/apps/Caravan-01 AlexLerxst Karaván-01
Szervezet https://appcenter.ms/orgs/BallardFlowers/apps/BouquetOrders-app BallardFlowers BouquetOrders-app

Keresse meg az owner_name és app_name értékeket az App Center parancssori felület használatával.

Ha még nem telepítette az App Center parancssori felületét, a telepítési és használati utasítások az App Center PARANCSSORI dokumentációjában találhatók.

A telepítés után a következő parancs futtatásával kérje le a hozzáféréssel rendelkező alkalmazások listáját:

appcenter apps list

Az App Center parancssori felülete megjeleníti az alkalmazások listáját a formátummal {owner-name}/{app-name}.

A parancssori függvények teljes listájáért tekintse meg az App Center parancssori felületének dokumentációját .

API-jogkivonat használata az App Center OpenAPI-specifikációjával

Az App Center OpenAPI specifikációja kezeli az API-hitelesítést, így nem kell beillesztenie az API-jogkivonatot a kérések fejléceibe. Az App Center API-k tesztelése az API-jogkivonattal:

  1. Az API-k megismeréséhez lépjen az App Center OpenAPI-specifikációjához .

  2. A jobb felső sarokban kattintson az Engedélyezés gombra.

  3. Az APIToken szakaszban illessze be az API-jogkivonatot az Érték mezőbe, és kattintson az Engedélyezés gombra.

    API-jogkivonat beállítása az App Center használatának engedélyezéséhez

  4. Ha az "Engedélyezett" és a Kijelentkezés gomb jelenik meg, az engedélyezés sikeres volt. Az előugró ablak jobb felső sarkában kattintson az "X" elemre az előugró ablakból való kilépéshez.

Az első API-hívás indítása Az OpenAPI (Swagger) használatával

Ez a szakasz bemutatja, hogyan használhatja az App Center OpenAPI-oldalát az API-hívással GET /v0.1/user. Ez az API-hívás visszaadja a felhasználó profiladatait.

  1. Hozzon létre egy API-jogkivonatot a fenti utasításokat követve.
  2. Engedélyezze az OpenAPI Specifikáció oldalának az API-jogkivonat használatát az előző szakaszban leírt utasítások szerint.
  3. A Fiók alatt kattintson a GET /v0.1/user gombra.
  4. A bal oldali sarokban kattintson a Kipróbálás gombra.
  5. Kattintson a Paraméterek szakasz Végrehajtás gombjára.
  6. Lenyűgöző! Most már láthatja a választ a Válaszok szakaszban.

API-jogkivonat visszavonása

Ha kiszivárog egy API-jogkivonat, azonnal vissza kell vonnia, hogy megakadályozza az App Center-fiókhoz való jogosulatlan hozzáférést.

Felhasználói API-jogkivonat visszavonása

  1. Navigáljon ide: https://appcenter.ms.
  2. Az App Center portál jobb felső sarkában kattintson a fiókavatárra, majd válassza a Fiókbeállítások lehetőséget.
  3. A középső panelen válassza a Felhasználói API-jogkivonatok lehetőséget a menüből.
  4. Jelölje be a visszavonni kívánt jogkivonat melletti jelölőnégyzetet, és kattintson a jobb felső sarokban található Törlés gombra.

App API-jogkivonat visszavonása

  1. Navigáljon ide: https://appcenter.ms.
  2. Válassza ki azt az alkalmazást , amelyhez egy API-jogkivonatot vissza szeretne vonni.
  3. A bal oldalon válassza a Beállítások lehetőséget.
  4. A középső panelen válassza az App API-jogkivonatokat a menüből.
  5. Jelölje be a visszavonni kívánt jogkivonat melletti jelölőnégyzetet, és kattintson a jobb felső sarokban található Törlés gombra.
  • Last updated on