Partage via

Considérations relatives à l’API

  • Article

Contrôle de version des API

Note

Les API du portail Cloud Partner sont intégrées et continueront de travailler dans l’Espace partenaires. La transition introduit de petites modifications. Passez en revue les modifications répertoriées dans informations de référence sur l’API du portail Cloud Partner pour vous assurer que votre code continue de fonctionner après la transition vers l’Espace partenaires. Les API CPP ne doivent être utilisées que pour les produits existants qui ont déjà été intégrés avant la transition vers l’Espace partenaires ; les nouveaux produits doivent utiliser les API de soumission de 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 appeler en fournissant le paramètre api-version dans le cadre de la chaîne de requête.

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

La réponse à une requête avec une version d’API inconnue ou non valide est un code HTTP 400. Cette erreur retourne la collection de versions d’API connues 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 éventuellement, des informations supplémentaires dans la réponse sérialisée en tant que JSON. Lorsque vous recevez une erreur, en particulier une erreur de classe 400, ne réessayez pas la requête avant de corriger 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 requis pour recevoir une réponse valide ; s’il n’est pas présent, une erreur 401 Unauthorized est retournée.

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

    Accept: application/json 
    Authorization: Bearer <YOUR_TOKEN>