Sdílet prostřednictvím

Dokumentace k rozhraní API služby App Center

Důležité

Visual Studio App Center bylo vyřazeno 31. března 2025 s výjimkou funkcí Analýzy a diagnostiky, které se budou dál podporovat až do 30. června 2026. Další informace.

Specifikace OpenAPI pro App Center (Swagger)

App Center zveřejňuje úplnou sadu koncových bodů rozhraní API. Rozhraní API služby App Center můžete prozkoumat prostřednictvím specifikace OpenAPI pro App Center.

Specifikace OpenAPI pro App Center umožňuje ověření pomocí tokenu rozhraní API. Jakmile budete ověřeni, můžete volat rozhraní API služby App Center, abyste se dozvěděli o rozhraní API a zjistili, jaká data vrací.

Typy tokenů: tokeny uživatele a tokeny aplikací

App Center zveřejňuje dva druhy tokenů rozhraní API: tokeny uživatelů a tokeny aplikací.

Tokeny uživatelského rozhraní API mají stejná práva jako uživatel App Center. Tokeny uživatelského rozhraní API fungují ve všech organizacích a aplikacích, ke kterým jste přidruženi.

Tokeny rozhraní API aplikací mají práva správce nebo prohlížeče, ale pouze v jedné aplikaci.

Každý účet App Center může vytvořit až 5 000 tokenů rozhraní API.

Návod

Doporučujeme vytvářet a používat tokeny rozhraní App API k omezení rozsahu autorizace jenom na jednu aplikaci najednou (a omezit riziko, pokud je token vystavený). Pokud potřebujete automatizovat něco nad rámec jedné aplikace, jako je například práce s organizacemi nebo sdílenými distribučními skupinami, měli byste vytvořit token rozhraní API uživatele.

Výstraha

Nevkládejte tokeny rozhraní API do zdrojového kódu. Tokeny rozhraní API by se měly považovat za tajné kódy a bezpečně je ukládat.

Výstraha

Požadavek musí obsahovat datový obsah pro volání API POST/PUT/PATCH. Použijte {} pro prázdné tělo datového paketu, jinak API volání obdrží chybovou odpověď 411 Délka požadována.

Vytvoření tokenu rozhraní App Center App API

  1. Přejděte na https://appcenter.ms a přihlaste se pomocí přihlašovacích údajů svého účtu.

  2. Vyberte aplikaci , pro kterou chcete vytvořit token rozhraní API.

  3. Na levé straně zvolte Nastavení.

  4. Na prostředním panelu vyberte ze seznamu nabídky App API Tokens.

  5. V pravém horním rohu klikněte na Nový token rozhraní API.

  6. Do textového pole zadejte popisný název tokenu.

  7. Vyberte typ přístupu pro token rozhraní API aplikace:

    Úplný přístup: Token rozhraní API aplikace s úplným přístupem má ekvivalent oprávnění Správce pro danou aplikaci. Pouze správci můžou vytvářet tokeny rozhraní APP API s úplným přístupem.

    Jen pro čtení: Token rozhraní API aplikace jen pro čtení má ekvivalent oprávnění pro přístup k prohlížeči pro danou aplikaci. Správci a vývojáři můžou vytvářet tokeny rozhraní APP API jen pro čtení.

  8. V dolní části panelu klikněte na Přidat nový token rozhraní API.

  9. Otevře se okno s tokenem API aplikace. Zkopírujte a uložte ho do zabezpečeného umístění pro pozdější použití. Z bezpečnostních důvodů nemůžete po kliknutí na tlačítko Close znovu zobrazit nebo vygenerovat stejný token.

  10. Klikněte na tlačítko Zavřít .

Vytvoření tokenu uživatelského rozhraní API služby App Center

  1. Přejděte na https://appcenter.ms a přihlaste se pomocí přihlašovacích údajů svého účtu.

  2. V pravém horním rohu portálu App Center klikněte na avatar účtu a pak vyberte Nastavení účtu.

  3. Na prostředním panelu vyberte ze seznamu nabídek tokeny rozhraní API uživatele.

  4. V pravém horním rohu klikněte na Nový token rozhraní API.

  5. Do textového pole zadejte popisný název tokenu.

  6. Vyberte typ přístupu pro token rozhraní API uživatele:

    Úplný přístup: Token uživatelského rozhraní API s úplným přístupem má všechna oprávnění, která máte pro aktuální účet nebo organizaci. Pokud například nemáte oprávnění správce nebo vývojáře pro aplikaci, uživatel nemůže spustit test, i když používáte token uživatelského rozhraní API s úplným přístupem.

    Jen pro čtení: Token uživatelského rozhraní API jen pro čtení má oprávnění k přístupu prohlížeče pro aktuální účet nebo organizaci. Například pomocí tokenu uživatelského rozhraní API jen pro čtení můžete číst data z chybových ukončení, analýz a získat základní informace o aplikaci. Tokeny uživatelského rozhraní API jen pro čtení nemůžou měnit nastavení aplikace, vytvářet konfiguraci exportu atd.

  7. V dolní části panelu klikněte na Přidat nový token rozhraní API.

  8. Otevře se vyskakovací okno s vaším uživatelským API tokenem. Zkopírujte a uložte ho do zabezpečeného umístění pro pozdější použití. Z bezpečnostních důvodů nemůžete po kliknutí na tlačítko Close znovu zobrazit nebo vygenerovat stejný token.

  9. Klikněte na tlačítko Zavřít .

Použití tokenu rozhraní API v požadavku rozhraní API

Při odesílání požadavků rozhraní API do App Center z aplikace musíte do hlavičky každého požadavku odeslaného do App Center zahrnout token rozhraní API.

Předejte token rozhraní API ve vlastnosti hlavičky X-API-Token požadavku.

Najděte název aplikace App Center a jméno vlastníka

Některé funkce rozhraní API app Center a požadavky rozhraní příkazového řádku vyžadují jako parametry název aplikace nebo název vlastníka.

Například volání rozhraní API pro odebrání uživatele z aplikace vyžaduje obojí: DELETE /v0.1/apps/{owner_name}/{app_name}/users/{user_email}.

Název a jméno vlastníka aplikace najdete z adresy URL App Center nebo pomocí rozhraní příkazového řádku app Center.

Najděte owner_name a app_name z URL App Center.

  1. Přejděte na https://appcenter.ms.
  2. Přejděte do aplikace.
  3. Když se podíváte na adresu URL aplikace, je ve formátu https://appcenter.ms/users/{owner-name}/apps/{app-name}.

Vlastníkem může být uživatel nebo organizace. Například:

Vlastník Adresa URL Jméno vlastníka Název aplikace
Uživatel https://appcenter.ms/users/AlexLerxst/apps/Caravan-01 AlexLerxst Caravan-01
Org https://appcenter.ms/orgs/BallardFlowers/apps/BouquetOrders-app BallardFlowers Aplikace KyticeObjednávky

Vyhledání owner_name a app_name v rozhraní příkazového řádku App Center

Pokud jste ještě nenainstalovali rozhraní příkazového řádku app Center, najdete pokyny k instalaci a použití v dokumentaci k rozhraní příkazového řádku App Center.

Po instalaci načtěte seznam aplikací, ke kterým máte přístup, spuštěním následujícího příkazu:

appcenter apps list

Rozhraní příkazového řádku app Center zobrazí seznam aplikací s formátem {owner-name}/{app-name}.

Úplný seznam funkcí příkazového řádku najdete v dokumentaci k rozhraní příkazového řádku app Center .

Použití tokenu rozhraní API se specifikací OpenAPI služby App Center

Specifikace OpenAPI pro App Center zpracovává ověřování rozhraní API za vás, takže token rozhraní API nemusíte vkládat do hlaviček vašich požadavků. Testování rozhraní API služby App Center pomocí tokenu rozhraní API:

  1. Přejděte na specifikaci OpenAPI pro App Center, kde můžete prozkoumat naše rozhraní API.

  2. V pravém horním rohu klikněte na tlačítko Autorizovat .

  3. V části APIToken vložte token rozhraní API do hodnoty a klikněte na Autorizovat.

    Nastavení tokenu rozhraní API pro autorizaci využití App Center

  4. Pokud se zobrazí "Autorizované" a tlačítko Odhlášení, autorizace byla úspěšná. V pravém horním rohu automaticky otevíraného okna kliknutím na symbol X zavřete automaticky otevírané okno.

Vytvoření prvního volání rozhraní API pomocí OpenAPI (Swagger)

V této části se dozvíte, jak používat stránku OpenAPI App Center pomocí volání rozhraní API GET /v0.1/user. Toto volání rozhraní API vrátí profilová data uživatele.

  1. Podle výše uvedených pokynů vytvořte token rozhraní API.
  2. Autorizujte stránku specifikace OpenAPI k použití vašeho tokenu rozhraní API podle pokynů v předchozí části.
  3. V části Účet klikněte na GET /v0.1/user.
  4. V levém rohu klikněte na tlačítko Vyzkoušet .
  5. Klikněte na tlačítko Spustit v části Parametry .
  6. Výborně! Odpověď se teď zobrazí v části Odpovědi .

Odvolání tokenu rozhraní API

Pokud dojde k úniku tokenu rozhraní API, měli byste ho okamžitě odvolat, abyste zabránili neoprávněnému přístupu k vašemu účtu App Center.

Odvolání tokenu uživatelského rozhraní API

  1. Přejděte na https://appcenter.ms.
  2. V pravém horním rohu portálu App Center klikněte na avatar účtu a pak vyberte Nastavení účtu.
  3. Na prostředním panelu vyberte v nabídce tokeny uživatelského rozhraní API .
  4. Zaškrtněte políčko vedle tokenu, který chcete odvolat, a v pravém horním rohu klikněte na tlačítko Odstranit .

Odvolání tokenu rozhraní API aplikace

  1. Přejděte na https://appcenter.ms.
  2. Vyberte aplikaci , pro kterou chcete odvolat token rozhraní API.
  3. Na levé straně zvolte Nastavení.
  4. Na prostředním panelu vyberte v nabídce tokeny rozhraní APP API .
  5. Zaškrtněte políčko vedle tokenu, který chcete odvolat, a v pravém horním rohu klikněte na tlačítko Odstranit .
  • Last updated on