API belgelerini App Center

App Center Openapı belirtimi (Swagger)

App Center, tüm API uç noktaları kümesini kullanıma sunar. App Center API 'sini App Center Openapı belirtimiaracılığıyla inceleyebilirsiniz.

App Center Openapı belirtimi, API belirtecinizi kullanarak kimlik doğrulaması yapmanıza olanak sağlar. Kimliğiniz doğrulandıktan sonra API hakkında bilgi edinmek ve döndürdüğü verileri görmek için App Center API 'Leri çağırabilirsiniz.

Belirteç türleri: Kullanıcı belirteçleri ve uygulama belirteçleri

App Center iki tür API belirteci sunar: Kullanıcı belirteçleri ve uygulama belirteçleri.

Kullanıcı API belirteçleri, App Center kullanıcısı ile aynı haklara sahiptir. Kullanıcı API belirteçleri, ilişkili olduğunuz tüm kuruluşlar ve uygulamalar arasında çalışır.

Uygulama API belirteçleri, yalnızca bir uygulama içinde yönetici veya Görüntüleyici haklarına sahiptir.

Her bir App Center hesabı en fazla 5000 API belirteci oluşturabilir.

App Center Uygulama API'si belirteci oluşturma

1. hesabına https://appcenter.ms gidin ve hesap kimlik bilgilerinizi kullanarak oturum açın.

2. API belirteci oluşturmak istediğiniz uygulamayı seçin.

3. Sol tarafta Ayarlar'ı seçin.

4. Ortadaki panelde, menü listesinden Uygulama API Belirteçleri'ni seçin.

5. Sağ üst köşede Yeni API belirteci'ne tıklayın.

6. Metin alanına belirteciniz için açıklayıcı bir ad girin.

7. Uygulama API'si belirtecin erişim türünü seçin:

   Tam Erişim: Tam erişimli Uygulama API'si belirteci, bu uygulama için Yönetici izinlerine eşdeğerdir. Yalnızca Yöneticiler tam erişimli Uygulama API'si belirteçleri oluşturabilir.

   Salt Okunur: Salt okunur Uygulama API'si belirteci, o uygulama için Görüntüleyici erişim izinlerine eşdeğerdir. Yöneticiler ve Geliştiriciler salt okunur Uygulama API'si belirteçleri oluşturabilir.

8. Panelin alt kısmında Yeni API belirteci ekle'ye tıklayın.

9. Uygulama API'si belirtecinle birlikte bir açılır pencere açılır. Daha sonra kullanmak üzere kopyalayıp güvenli bir konumda depolar. Güvenlik nedeniyle Kapat düğmesine tıklarken aynı belirteci yeniden göreyesiniz veya oluşturasınız.

10. Kapat düğmesine tıklayın.

App Center Kullanıcı API'si belirteci oluşturma

1. hesabına https://appcenter.ms gidin ve hesap kimlik bilgilerinizi kullanarak oturum açın.

2. App Center portalının sağ üst köşesinde hesap avatarınıza tıklayın ve Hesap Ayarları'ı seçin.

3. Orta bölmede, menü listesinden Kullanıcı API belirteçleri ' ni seçin.

4. Sağ üst köşedeki yenı API belirteci' ne tıklayın.

5. Metin alanına belirteciniz için açıklayıcı bir ad girin.

6. Kullanıcı API belirtecinizin erişim türünü seçin:

   Tam erişim: Tam erişim Kullanıcı API belirteci, geçerli hesap/kuruluş için sahip olduğunuz tüm izinlere sahiptir. Örneğin, bir uygulama için yönetici veya geliştirici izinleriniz yoksa, tam erişim Kullanıcı API belirteci kullanıyor olsanız bile, Kullanıcı bir testi çalıştıramıyorum.

   Salt okunurdur: Salt okunurdur bir Kullanıcı API belirtecinin geçerli hesap/kuruluş için Görüntüleyici erişim izni vardır. Örneğin, salt okunurdur bir Kullanıcı API belirteci ile kilitlenmeler, Analytics 'ten verileri okuyabilir ve temel uygulama bilgilerini edinebilirsiniz. Salt okuma Kullanıcı API belirteçleri, uygulama ayarlarını değiştiremez, bir derlemeyi tetikleyemez, dışarı aktarma yapılandırması oluşturamaz vb.

7. Panelin alt kısmındaki yenı API belirteci Ekle' ye tıklayın.

8. Bir açılır pencere, Kullanıcı API belirtecinizle birlikte açılır. Daha sonra kullanmak üzere güvenli bir konuma kopyalayın ve saklayın . Güvenlik nedenleriyle, Kapat düğmesine tıkladıktan sonra aynı belirteci yeniden göremez veya oluşturamazsınız.

9. Kapat düğmesine tıklayın.

API isteğinde API belirteci kullanma

Bir uygulamadan App Center API istekleri gönderirken, App Center gönderilen her isteğin üstbilgisine API belirtecini dahil etmeniz gerekir.

İsteğin X-API-Token üst bilgi ÖZELLIĞINE API belirtecini geçirin.

App Center uygulamanızın adını ve sahip adını bulun

App Center API işlevleri ve CLı isteklerinin bazıları parametre olarak bir uygulama adı veya sahip adı gerektirir.

Örneğin, uygulamayı uygulamadan kaldırmak için API çağrısı her ikisini de gerektirir: DELETE /v0.1/apps/{owner_name}/{app_name}/users/{user_email} .

Uygulama adını ve sahip adını App Center URL'den veya App Center CLI kullanarak bulabilirsiniz.

Url owner_name den app_name ve App Center bulma

1. 'a https://appcenter.ms gidin.
2. Uygulamanıza gidin.
3. Uygulama url'nize bakarak https://appcenter.ms/users/{owner-name}/apps/{app-name} biçimindedir.

Sahip bir kullanıcı veya kuruluş olabilir. Örnek:

app_name CLI owner_name den App Center ve App Center bulma

App Center CLI'sini henüz yüklememişsinizdir, yükleme ve kullanım yönergeleri App Center CLI belgelerinde bulunabilir.

Yüklendikten sonra aşağıdakini çalıştırarak erişiminiz olan uygulamaların listesini alın:

appcenter apps list

App Center CLI biçiminde bir uygulama listesi {owner-name} / {app-name} görüntüler.

Komut satırı işlevlerinin App Center listesi için App Center CLI belgelerine bakın.

OpenAPI Belirtimi ile API App Center Kullanma

OpenAPI App Center api kimlik doğrulamasını sizin için üst bilgi olarak kullanır, bu nedenle istekleriniz için API belirteci üst bilgilerine yapıştırmanız gerekmesin. Api belirtec App Center API'lerinizi test etmek için:

1. API'lerimizi App Center için OpenAPI belirtimleri'ne gidin.

2. Sağ üst köşedeki Yetkilendir düğmesine tıklayın.

3. Apitoken bölümü altında, API belirtecini değere yapıştırın ve Yetkilendir' e tıklayın.

   

4. "Yetkilendirilmiş" ve bir oturum kapatma düğmesi gösteriyorsa, Yetkilendirme başarılı oldu. Açılır pencerenin sağ üst köşesinde, açılan menüden çıkmak için "X" düğmesine tıklayın.

Openapı (Swagger) kullanarak ilk API çağrısını yapma

Bu bölümde, API çağrısını kullanarak App Center Openapı sayfasının nasıl kullanılacağı gösterilmektedir GET /v0.1/user . Bu API çağrısı, kullanıcının profil verilerini döndürür.

1. Yukarıdakiyönergeleri IZLEYEREK bir API belirteci oluşturun.
2. Önceki bölümdeyer aldığı YÖNERGELERDEN sonra API belirtecinizi kullanmak Için Openapı belirtim sayfasını yetkilendirin.
3. Hesap altında, Açık ' a tıklayın GET /v0.1/user .
4. Sol köşede, deneyin düğmesine tıklayın.
5. Parametreler bölümünün altındaki Yürüt düğmesine tıklayın.
6. Harika! Yanıt, yanıtlar bölümünün altında görebilirsiniz.

Bir API belirtecini iptal etme

Bir API belirtecinin sızmış olması durumunda App Center hesabınıza yetkisiz erişimi engellemek için hemen iptal etmelisiniz.

Kullanıcı API belirtecini iptal etme

1. Öğesine gidin https://appcenter.ms .
2. App Center portalının sağ üst köşesinde, hesap avatarınızı ve sonra Hesap ayarları' nı seçin.
3. Orta bölmede, menüden Kullanıcı API belirteçleri ' ni seçin.
4. İptal etmek istediğiniz belirtecin yanındaki kutuyu işaretleyin ve sağ üst köşedeki Sil düğmesine tıklayın.

Uygulama API'si belirteci iptal

1. 'a https://appcenter.ms gidin.
2. API belirteci iptal etmek istediğiniz uygulamayı seçin.
3. Sol tarafta Ayarlar'ı seçin.
4. Ortadaki panelde, menüden Uygulama API Belirteçleri'ni seçin.
5. İptal etmek istediğiniz belirteci yanındaki kutuyu işaretleyin ve sağ üst köşedeki Sil düğmesine tıklayın.