API ile ilgili dikkat edilmesi gerekenler

API sürümü oluşturma

Not

Bulut İş Ortağı Portalı API'leri ile tümleşiktir ve İş Ortağı Merkezi'nde çalışmaya devam edecektir. Geçiş küçük değişiklikler sağlar. İş Ortağı Merkezi'ne geçtikten sonra kodunuzun çalışmaya devam ettiğinden emin olmak için Bulut İş Ortağı Portalı API Başvurusu'nda listelenen değişiklikleri gözden geçirin. CPP API'leri yalnızca İş Ortağı Merkezi'ne geçiş öncesinde zaten tümleştirilmiş olan mevcut ürünler için kullanılmalıdır; yeni ürünler İş Ortağı Merkezi gönderim API'lerini kullanmalıdır.

API'nin aynı anda kullanılabilen birden çok sürümü olabilir. İstemciler, sorgu dizesinin bir parçası olarak parametresini api-version sağlayarak hangi sürümü kullanmak istediklerini belirtmelidir.

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

Bilinmeyen veya geçersiz API sürümüne sahip bir isteğin yanıtı bir HTTP kodu 400'dür. Bu hata, yanıt gövdesindeki bilinen API sürümlerinin koleksiyonunu döndürür.

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

Hatalar

API, ilgili HTTP durum kodlarıyla hatalara yanıt verir ve isteğe bağlı olarak yanıttaki ek bilgiler JSON olarak seri hale getirilir. Özellikle de 400 sınıflık bir hata aldığınızda, temel nedeni düzeltmeden önce isteği yeniden denemeyin. Örneğin, yukarıdaki örnek yanıtta isteği yeniden göndermeden önce API sürüm parametresini düzeltin.

Yetkilendirme üst bilgisi

Bu başvurudaki tüm API'ler için, Microsoft Entra Kimliği'nden alınan taşıyıcı belirteci ile birlikte yetkilendirme üst bilgisini geçirmeniz gerekir. Geçerli bir yanıt almak için bu üst bilgi gereklidir; yoksa bir 401 Unauthorized hata döndürülür.

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

    Accept: application/json 
    Authorization: Bearer <YOUR_TOKEN>