Partage via

Considérations relatives aux API

  • Article

Contrôle de version d’API

Remarque

Les API de Portail Cloud Partner sont intégrées à Espace partenaires et continueront d’y fonctionner. La transition introduit de légères modifications. Passez en revue les changements répertoriés dans les informations de référence relatives aux API de Portail Cloud Partner pour vous assurer que votre code continue de fonctionner après la transition vers Espace partenaires. Les API du Portail Cloud Partner ne doivent être utilisées que pour les produits intégrés avant la transition vers l’Espace partenaires. Les nouveaux produits doivent employer les API de soumission à l’Espace partenaires.

Il peut y avoir plusieurs versions de l’API disponibles en même temps. Les clients doivent indiquer la version qu’ils souhaitent invoquer en fournissant le paramètre api-version en tant que partie de la chaîne de requête.

GET https://cloudpartner.azure.com/api/offerTypes?api-version=2017-10-31

Le code HTTP 400 est émis en cas de réponse à une requête avec une version d’API inconnue ou invalide. Cette erreur renvoie la collection des versions connues de l’API dans le corps de la réponse.

    {
        "error": { 
            "code":"InvalidAPIVersion",
            "message":"Invalid api version. Allowed values are [2016-08-01-preview]"
        }
    }

Erreurs

L’API répond aux erreurs avec les codes d’état HTTP correspondants et renvoie, éventuellement, des informations supplémentaires dans la réponse sérialisée au format JSON. Lorsque vous recevez une erreur, en particulier une erreur de classe 400, ne réexécutez pas la requête avant d’avoir corrigé la cause sous-jacente. Par exemple, dans l’exemple de réponse ci-dessus, corrigez le paramètre de version de l’API avant de renvoyer la requête.

En-tête d’autorisation.

Pour toutes les API de cette référence, vous devez transmettre l’en-tête d’autorisation avec le jeton du porteur obtenu à partir de l’ID Microsoft Entra. Cet en-tête est nécessaire pour recevoir une réponse valide ; s’il n’est pas fourni, une erreur 401 Unauthorized est renvoyée.

  GET https://cloudpartner.azure.com/api/offerTypes?api-version=2016-08-01-preview

    Accept: application/json 
    Authorization: Bearer <YOUR_TOKEN>