Dokumentation om App Center API

App Center OpenAPI-specifikation (Swagger)

App Center exponerar en fullständig uppsättning API-slutpunkter. Du kan utforska App Center-API:et via App Center OpenAPI-specifikationen.

Med App Center OpenAPI-specifikationen kan du autentisera med din API-token. När du har autentiserats kan du anropa App Center-API:er för att lära dig mer om API:et och se vilka data det returnerar.

Typer av token: användartoken och apptoken

App Center exponerar två typer av API-token: användartoken och apptoken.

Användar-API-token har samma rättigheter som du gör som användare av App Center. Användar-API-token fungerar i alla organisationer och appar som du är associerad med.

App-API-token har antingen behörighet som Chef eller Åskådare, men endast inom en app.

Varje App Center-konto kan skapa upp till 5 000 API-token.

Skapa en App Center App API-token

1. Navigera till https://appcenter.ms och logga in med dina kontoautentiseringsuppgifter.

2. Välj den app som du vill skapa en API-token för.

3. Välj Inställningar till vänster.

4. I den mellersta panelen väljer du App-API-token i menylistan.

5. I det övre högra hörnet klickar du på Ny API-token.

6. I textfältet anger du ett beskrivande namn för din token.

7. Välj typ av åtkomst för din app-API-token:

   Fullständig åtkomst: En api-token för fullständig åtkomst har motsvarande Manager-behörigheter för appen. Endast chefer kan skapa api-token för fullständig åtkomst.

   Skrivskyddad: En skrivskyddad app-API-token har motsvarande behörigheter för visningsåtkomst för appen. Cheferna och utvecklarna kan skapa skrivskyddade API-token för appar.

8. Klicka på Lägg till ny API-token längst ned i panelen.

9. Ett popup-fönster öppnas med din app-API-token. Kopiera och lagra den på en säker plats för senare användning. Av säkerhetsskäl kan du inte se eller generera samma token igen när du har klickat på knappen Stäng .

10. Klicka på knappen Stäng .

Skapa en Api-token för App Center-användare

1. Navigera till https://appcenter.ms och logga in med dina kontoautentiseringsuppgifter.

2. I det övre högra hörnet i App Center-portalen klickar du på din kontoavatar och väljer sedan Kontoinställningar.

3. I den mellersta panelen väljer du Användar-API-token i menylistan.

4. I det övre högra hörnet klickar du på Ny API-token.

5. I textfältet anger du ett beskrivande namn för din token.

6. Välj typ av åtkomst för din användar-API-token:

   Fullständig åtkomst: En api-token för fullständig åtkomst har alla behörigheter som du har för det aktuella kontot/organisationen. Om du till exempel inte har administratörs- eller utvecklarbehörigheter för en app kan användaren inte köra ett test, även om du använder en api-token för fullständig åtkomst.

   Skrivskyddad: En skrivskyddad användar-API-token har visningsåtkomstbehörighet för det aktuella kontot/organisationen. Med en skrivskyddad api-token för användare kan du till exempel läsa data från krascher, analyser och hämta grundläggande appinformation. Skrivskyddade API-token för användare kan inte ändra appinställningar, skapa en exportkonfiguration osv.

7. Klicka på Lägg till ny API-token längst ned i panelen.

8. Ett popup-fönster öppnas med din api-token för användare. Kopiera och lagra den på en säker plats för senare användning. Av säkerhetsskäl kan du inte se eller generera samma token igen när du har klickat på knappen Stäng .

9. Klicka på knappen Stäng .

Använda en API-token i en API-begäran

När du skickar API-begäranden till App Center från ett program måste du inkludera API-token i rubriken för varje begäran som skickas till App Center.

Skicka API-token i begärans headerfält X-API-Token.

Hitta ditt App Center-appnamn och ägarens namn

Vissa av App Centers API-funktioner och CLI-begäranden kräver ett appnamn eller ägarnamn som parametrar.

API-anropet för att ta bort användaren från appen kräver till exempel båda: DELETE /v0.1/apps/{owner_name}/{app_name}/users/{user_email}.

Du hittar appens namn och ägarnamn från en App Center-URL eller med hjälp av App Center CLI.

Hitta owner_name och app_name från en App Center-webbadress

1. Gå till https://appcenter.ms.
2. Gå till din app.
3. När du tittar på appens URL är den i formatet https://appcenter.ms/users/{owner-name}/apps/{app-name}.

Ägaren kan vara en användare eller en organisation. Till exempel:

Hitta owner_name och app_name med App Center CLI

Om du ännu inte har installerat App Center CLI finns installations- och användningsinstruktioner i App Center CLI-dokumentationen.

När du har installerat hämtar du listan över appar som du har åtkomst till genom att köra:

appcenter apps list

App Center CLI visar en lista över appar med formatet {owner-name}/{app-name}.

I App Center CLI-dokumentationen finns en fullständig lista över kommandoradsfunktioner.

Använda en API-token med App Center OpenAPI-specifikationen

App Center OpenAPI-specifikationen hanterar API-autentisering åt dig, så du behöver inte klistra in API-token i rubriker för dina begäranden. Så här testar du App Center-API:er med din API-token:

1. Gå till App Centers OpenAPI-specifikation för att utforska våra API:er.

2. Klicka på knappen Auktorisera i det övre högra hörnet.

3. Under avsnittet APIToken klistrar du in API-token i Värde och klickar på Auktorisera.

   

4. Om den visar "Auktoriserad" och en utloggningsknapp lyckades auktoriseringen. I popup-fönstrets övre högra hörn klickar du på "X" för att avsluta popup-fönstret.

Göra ditt första API-anrop med Hjälp av OpenAPI (Swagger)

Det här avsnittet visar hur du använder App Centers OpenAPI-sida med hjälp av API-anropet GET /v0.1/user. Det här API-anropet returnerar användarens profildata.

1. Skapa en API-token genom att följa anvisningarna ovan.
2. Auktorisera sidan OpenAPI-specifikation för att använda din API-token enligt anvisningarna i föregående avsnitt.
3. Under Konto klickar du på GET /v0.1/user.
4. I det vänstra hörnet klickar du på knappen Prova .
5. Klicka på knappen Kör under avsnittet Parametrar .
6. Toppen! Nu kan du se svaret under avsnittet Svar .

Återkalla en API-token

Om en API-token läcker bör du omedelbart återkalla den för att förhindra obehörig åtkomst till ditt App Center-konto.

Återkalla en api-token för användare

1. Gå till https://appcenter.ms.
2. I det övre högra hörnet i App Center-portalen klickar du på din kontoavatar och väljer sedan Kontoinställningar.
3. I den mellersta panelen väljer du Användar-API-token på menyn.
4. Markera kryssrutan bredvid den token som du vill återkalla och klicka på knappen Ta bort i det övre högra hörnet.

Återkalla en app-API-token

1. Gå till https://appcenter.ms.
2. Välj den app som du vill återkalla en API-token för.
3. Välj Inställningar till vänster.
4. I den mellersta panelen väljer du App-API-token på menyn.
5. Markera kryssrutan bredvid den token som du vill återkalla och klicka på knappen Ta bort i det övre högra hörnet.