Dokumentace k rozhraní API služby App Center

Specifikace OpenAPI služby 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ěřování pomocí tokenu rozhraní API. Po ověření můžete volat rozhraní API App Center, abyste se dozvěděli o rozhraní API a zjistili, jaká data vrací.

Typy tokenů: tokeny uživatelů 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 aplikace mají práva správce nebo prohlížeče, ale pouze v jedné aplikaci.

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

Tip

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 práce s organizacemi nebo sdílenými distribučními skupinami, měli byste vytvořit token uživatelského rozhraní API.

Upozornění

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.

Upozornění

Požadavek musí obsahovat text datové části pro volání rozhraní POST/PUT/PATCH API. Používá se {} pro prázdný text datové části, volání rozhraní API obdrží chybovou odpověď 411 Délka Požadovaná chyba jinak.

Vytvoření tokenu rozhraní App Center App API

  1. Přejděte na https://appcenter.ms přihlašovací údaje k účtu a přihlaste se.

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

  3. Na levé straně zvolte Nastavení.

  4. Na prostředním panelu vyberte v seznamu nabídek tokeny rozhraní APP API .

  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í APP API:

    Úplný přístup: Token rozhraní APP API 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 pro úplný přístup.

    Jen pro čtení: Token rozhraní APP API jen pro čtení má ekvivalent přístupových oprávnění prohlížeče 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 automaticky otevírané okno s tokenem rozhraní APP API. 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 Zavřít 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 přihlašovací údaje k účtu a přihlaste se.

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

  3. Na prostředním panelu vyberte v seznamu nabídek tokeny uživatelského rozhraní API .

  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 uživatelského rozhraní API:

    Úplný přístup: Token rozhraní API uživatele 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í pro přístup k prohlížeči pro aktuální účet nebo organizaci. Například s tokenem 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, aktivovat sestavení, vytvořit konfiguraci exportu atd.

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

  8. Otevře se automaticky otevírané okno s tokenem uživatelského rozhraní API. 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 Zavřít 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.

Vyhledání názvu aplikace a názvu vlastníka aplikace App Center

Některé z funkcí rozhraní API a požadavků rozhraní příkazového řádku App Center 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 obě: DELETE /v0.1/apps/{owner_name}/{app_name}/users/{user_email}.

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

Vyhledání owner_name a app_name z adresy URL Centra aplikací

  1. Přejděte na adresu 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 URL Jméno vlastníka Název aplikace
Uživatel https://appcenter.ms/users/AlexLerxst/apps/Caravan-01 AlexLerxst Karavan-01
Organizace https://appcenter.ms/orgs/BallardFlowers/apps/BouquetOrders-app BallardFlowers KyticeOrders-app

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

Pokud jste rozhraní příkazového řádku App Center ještě nenainstalovali, 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 tohoto 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 v dokumentaci k Rozhraní příkazového řádku .

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 ke specifikaci OpenAPI v App Center a prozkoumejte 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.

    Setting API token to authorize App Center usage

  4. Pokud se zobrazí "Autorizované" a tlačítko Pro 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 pomocí volání GET /v0.1/userrozhraní API použít stránku OpenAPI centra App Center. Toto volání rozhraní API vrátí profilová data uživatele.

  1. Podle výše uvedených pokynů vytvořte token rozhraní API.
  2. Povolte stránku specifikace OpenAPI tak, aby používala token 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 adresu https://appcenter.ms.
  2. V pravém horním rohu portálu App Center klikněte na avatar vašeho účtu a pak vyberte Účet Nastavení.
  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 klikněte na tlačítko Odstranit v pravém horním rohu.

Odvolání tokenu rozhraní App API

  1. Přejděte na adresu 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 klikněte na tlačítko Odstranit v pravém horním rohu.