Partager via

Documentation de l’API App Center

Important

Visual Studio App Center a été mis hors service le 31 mars 2025, à l’exception des fonctionnalités d’analyse et de diagnostic, qui continueront d’être prises en charge jusqu’au 30 juin 2026. En savoir plus.

Spécification OpenAPI pour App Center (Swagger)

App Center expose un ensemble complet de points de terminaison d’API. Vous pouvez explorer l’API App Center via la spécification OpenAPI d’App Center.

La spécification OpenAPI d’App Center vous permet de vous authentifier à l’aide de votre jeton d’API. Une fois que vous êtes authentifié, vous pouvez appeler les API App Center pour en savoir plus sur l’API et voir les données qu’elle retourne.

Types de jetons : jetons utilisateur et jetons d’application

App Center expose deux types de jetons d’API : les jetons utilisateur et les jetons d’application.

Les jetons d’API utilisateur ont les mêmes droits que ceux que vous faites en tant qu’utilisateur d’App Center. Les jetons d’API utilisateur fonctionnent dans toutes les organisations et applications auxquelles vous êtes associé.

Les jetons API de l'application ont des droits d'administrateur ou de spectateur, mais seulement dans une application.

Chaque compte App Center peut créer jusqu’à 5 000 jetons d’API.

Conseil / Astuce

Nous vous recommandons de créer et d’utiliser des jetons d’API d’application pour limiter l’étendue d’autorisation à une seule application à la fois (et limiter le risque si un jeton est exposé). Si vous devez automatiser quelque chose au-delà d’une application, comme travailler avec des organisations ou des groupes de distribution partagés, vous devez créer un jeton d’API utilisateur.

Avertissement

N’incorporez pas de jetons d’API dans le code source. Les jetons d’API doivent être traités comme des secrets et stockés en toute sécurité.

Avertissement

Une requête doit contenir un corps de charge utile pour les appels d’API POST/PUT/PATCH. Utilisez {} pour un corps de charge utile vide ; sinon, les appels d’API recevront une réponse d’erreur 411 Longueur requise.

Création d’un jeton d’API d’application App Center

  1. Accédez à https://appcenter.ms et connectez-vous en utilisant vos identifiants de compte.

  2. Sélectionnez l’application pour laquelle vous souhaitez créer un jeton d’API.

  3. Sur le côté gauche, choisissez Paramètres.

  4. Dans le panneau central, sélectionnez Jetons d’API d’application dans la liste de menus.

  5. Dans le coin supérieur droit, cliquez sur Nouveau jeton d’API.

  6. Dans le champ de texte, entrez un nom descriptif pour votre jeton.

  7. Sélectionnez le type d’accès pour votre jeton d’API d’application :

    Accès complet : Un jeton d’API d’application d’accès complet a l’équivalent des autorisations du Gestionnaire pour cette application. Seuls les gestionnaires peuvent créer des jetons d’API d’application d’accès complet.

    Lecture seule : Un jeton d'API d'application en lecture seule a l'équivalent des droits d'accès lecteur pour cette application. Les gestionnaires et les développeurs peuvent créer des jetons d’API d’application en lecture seule.

  8. En bas du panneau, cliquez sur Ajouter un nouveau jeton d’API.

  9. Une fenêtre contextuelle s’ouvre avec votre jeton d’API d’application. Copiez et stockez-la dans un emplacement sécurisé pour une utilisation ultérieure. Pour des raisons de sécurité, vous ne pouvez pas voir ou générer à nouveau le même jeton après avoir cliqué sur le bouton Fermer .

  10. Cliquez sur le bouton Fermer .

Création d’un jeton d’API utilisateur App Center

  1. Accédez à https://appcenter.ms et connectez-vous en utilisant vos identifiants de compte.

  2. Dans le coin supérieur droit du portail App Center, cliquez sur votre avatar de compte, puis sélectionnez Paramètres du compte.

  3. Dans le panneau central, sélectionnez Jetons d’API utilisateur dans la liste de menus.

  4. Dans le coin supérieur droit, cliquez sur Nouveau jeton d’API.

  5. Dans le champ de texte, entrez un nom descriptif pour votre jeton.

  6. Sélectionnez le type d’accès pour votre jeton d’API utilisateur :

    Accès complet : Un jeton d’API utilisateur d’accès complet dispose de toutes les autorisations dont vous disposez pour le compte/organisation actuel. Par exemple, si vous n’avez pas d’autorisations de gestionnaire ou de développeur pour une application, l’utilisateur ne peut pas exécuter de test, même si vous utilisez un jeton d’API utilisateur d’accès complet.

    Lecture seule : Un jeton d'API utilisateur en lecture seule possède une autorisation d'accès visionneur pour le compte ou l'organisation actuel. Par exemple, avec un jeton d’API utilisateur en lecture seule, vous pouvez lire les données des incidents, des analyses et obtenir des informations de base sur l’application. Les jetons d’API utilisateur en lecture seule ne peuvent pas modifier les paramètres de l’application, créer une configuration d’exportation, etc.

  7. En bas du panneau, cliquez sur Ajouter un nouveau jeton d’API.

  8. Une fenêtre contextuelle s’ouvre avec votre jeton d’API utilisateur. Copiez et stockez-la dans un emplacement sécurisé pour une utilisation ultérieure. Pour des raisons de sécurité, vous ne pouvez pas voir ou générer à nouveau le même jeton après avoir cliqué sur le bouton Fermer .

  9. Cliquez sur le bouton Fermer .

Utilisation d’un jeton d’API dans une requête d’API

Lorsque vous envoyez des demandes d’API à App Center à partir d’une application, vous devez inclure le jeton d’API dans l’en-tête de chaque requête envoyée à App Center.

Transmettez le jeton d’API dans la propriété d’en-tête de la requête X-API-Token.

Rechercher le nom de votre application App Center et le nom du propriétaire

Certaines des fonctions API d’App Center et des requêtes CLI nécessitent un nom d’application ou un nom de propriétaire en tant que paramètres.

Par exemple, l’appel d’API pour supprimer l’utilisateur de l’application nécessite les deux : DELETE /v0.1/apps/{owner_name}/{app_name}/users/{user_email}.

Vous pouvez trouver le nom de l’application et le nom du propriétaire à partir d’une URL App Center ou à l’aide de l’interface CLI App Center.

Trouver owner_name et app_name à partir d’une URL App Center

  1. Accédez à https://appcenter.ms.
  2. Accédez à votre application.
  3. Lorsque vous examinez l’URL de votre application, elle est au format https://appcenter.ms/users/{owner-name}/apps/{app-name}.

Le propriétaire peut être un utilisateur ou une organisation. Par exemple:

Propriétaire URL Nom du propriétaire Nom de l’application
Utilisateur https://appcenter.ms/users/AlexLerxst/apps/Caravan-01 AlexLerxst Caravane-01
Org https://appcenter.ms/orgs/BallardFlowers/apps/BouquetOrders-app BallardFlowers Application de commandes de bouquets

Rechercher owner_name et app_name à l'aide de l'interface en ligne de commande d'App Center.

Si vous n’avez pas encore installé l’interface CLI App Center, vous trouverez des instructions d’installation et d’utilisation dans la documentation de l’interface CLI App Center.

Une fois installé, récupérez la liste des applications auxquelles vous avez accès en exécutant :

appcenter apps list

App Center CLI affiche une liste d’applications, avec le format {owner-name}/{app-name}.

Reportez-vous à la documentation de l’interface CLI App Center pour obtenir la liste complète des fonctions de ligne de commande.

Utilisation d’un jeton d’API avec la spécification OpenAPI d’App Center

La spécification App Center OpenAPI gère l’authentification d’API pour vous. Vous n’avez donc pas besoin de coller le jeton d’API dans des en-têtes pour vos demandes. Pour tester les API App Center avec votre jeton d’API :

  1. Accédez à la spécification OpenAPI de l'App Center pour découvrir nos API.

  2. Dans le coin supérieur droit, cliquez sur le bouton Autoriser .

  3. Dans la section APIToken , collez le jeton d’API dans Valeur , puis cliquez sur Autoriser.

    Définition du jeton d’API pour autoriser l’utilisation d’App Center

  4. S’il affiche « Autorisé » et un bouton Déconnexion, l’autorisation a réussi. Dans le coin supérieur droit de la fenêtre contextuelle, cliquez sur « X » pour quitter la fenêtre contextuelle.

Effectuer votre premier appel d’API à l’aide d’OpenAPI (Swagger)

Cette section vous montre comment utiliser la page OpenAPI d’App Center à l’aide de l’appel GET /v0.1/userd’API. Cet appel d’API retourne les données de profil de l’utilisateur.

  1. Créez un jeton d’API en suivant les instructions ci-dessus.
  2. Autorisez la page Spécification OpenAPI à utiliser votre jeton d’API en suivant les instructions de la section précédente.
  3. Sous Compte, cliquez sur GET /v0.1/user.
  4. Dans le coin gauche, cliquez sur le bouton Essayer .
  5. Cliquez sur le bouton Exécuter sous la section Paramètres .
  6. Magnifique. Vous pouvez maintenant voir la réponse dans la section Réponses .

Révocation d’un jeton d’API

En cas de fuite d’un jeton d’API, vous devez le révoquer immédiatement pour empêcher tout accès non autorisé à votre compte App Center.

Révocation d’un jeton d’API utilisateur

  1. Accédez à https://appcenter.ms.
  2. Dans le coin supérieur droit du portail App Center, cliquez sur votre avatar de compte, puis sélectionnez Paramètres du compte.
  3. Dans le panneau central, sélectionnez Jetons d’API utilisateur dans le menu.
  4. Cochez la case en regard du jeton que vous souhaitez révoquer, puis cliquez sur le bouton Supprimer dans le coin supérieur droit.

Révocation d’un jeton d’API d’application

  1. Accédez à https://appcenter.ms.
  2. Sélectionnez l’application pour laquelle vous souhaitez révoquer un jeton d’API.
  3. Sur le côté gauche, choisissez Paramètres.
  4. Dans le panneau central, sélectionnez Jetons d’API d’application dans le menu.
  5. Cochez la case en regard du jeton que vous souhaitez révoquer, puis cliquez sur le bouton Supprimer dans le coin supérieur droit.