Portal kullanıcıları portalınızla nasıl etkileşimde bulunur?

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. info

Geliştirici portalı, portal kullanıcılarınızın kullanıcı hesabı oluşturmasını, oturum açmasını ve API'lerinizi kullanacak uygulamaları yönetmesini sağlar.

Aşağıdaki bölümlerde, portal kullanıcılarının portalınızla nasıl etkileşimde bulunduğu açıklanmaktadır.

Portalda oturum açın

Aşağıdaki bölümlerde, portal kullanıcılarının kullanıcı kimlik bilgilerini (yerleşik kimlik sağlayıcı) veya SAML'i (beta) kullanarak entegre portalda nasıl oturum açtıkları açıklanmaktadır.

Hem yerleşik hem de SAML kimlik sağlayıcıları etkinleştirirseniz portal kullanıcıları, oturum açmak için tercih ettikleri yöntemi seçebilir.

Kullanıcı kimlik bilgilerini (yerleşik kimlik sağlayıcı) kullanarak portalda oturum açma

Yerleşik kimlik sağlayıcı etkinleştirildiğinde portal kullanıcıları, aşağıdaki bölümlerde açıklandığı gibi kullanıcı kimlik bilgilerini (kullanıcı adı ve şifre) kullanarak entegre portalda oturum açabilir:

Entegre portalda kullanıcı hesabı oluşturma

Yerleşik kimlik sağlayıcıyla, portal kullanıcılarının API'lerinizi kullanabilmesi için entegre portalda kullanıcı hesabı oluşturmaları gerekir.

Portal kullanıcıları, entegre portalda aşağıdaki adımları uygulayarak kullanıcı hesabı oluşturur:

  1. Portala gidin.

  2. Oturum aç'ı tıklayın.

    Oturum açma sayfası görüntülenir.

  3. Hesap oluştur'u tıklayın.

    Hesabınızı oluşturun sayfası görüntülenir.

    Hesabınızı oluşturun iletişim kutusu

  4. Formu doldurun.

    Tüm zorunlu alanlar için değer girmeniz gerekir. Şifreler en az 8 karakter uzunluğunda olmalı ve aşağıdakilerden en az birini içermelidir: sayı, küçük harf, büyük harf ve özel karakter.

  5. Şartları inceleyip kabul edin.

  6. Hesap Oluştur'u tıklayın.

  7. CAPTCHA formunu doldurun ve Doğrula'yı (gösterilirse) tıklayın.

    Kullanıcı hesabı oluşturulur ve bir onay e-postası gönderilir.

  8. Kayıt işlemini tamamlamak için 10 dakika içinde onay e-postasındaki bağlantıyı tıklayın.

    Bağlantıyı 10 dakika içinde tıklamazsanız hesap oluşturmak ve yeniden istem almak için bu prosedürdeki adımları tekrarlamanız gerekir.

  9. Entegre portalda oturum açın (aşağıda açıklanmıştır).

Entegre portalda oturum açma

Yerleşik kimlik sağlayıcıyla, portal kullanıcıları entegre portala kaydolduktan ve onaylandıktan sonra kimlik bilgilerini (kullanıcı adı ve şifre) kullanarak oturum açar.

Portal kullanıcıları aşağıdaki şekilde oturum açar:

  1. Portala gidin.
  2. Oturum aç'ı tıklayın. Oturum açma sayfasında şunlar gösterilir: Oturum açma sayfası
  3. E-posta adresini ve şifreyi girin.
  4. Oturum aç'ı tıklayın.

Şifreyi değiştirme

Yerleşik kimlik sağlayıcıyla portal kullanıcıları şifreyi aşağıdaki gibi değiştirir:

  1. Portala gidin.
  2. Oturum aç'ı tıklayın.
  3. Şifreyi Sıfırla'yı tıklayın.
  4. Sıfırlanacak hesabın e-posta adresini girin.

  5. Şifreyi Sıfırlama Bağlantısı Gönder'i tıklayın.

    E-postaya şifre sıfırlama bağlantısı gönderilir.

  6. Onay e-postasındaki bağlantıyı tıklayın.

  7. Yeni şifreyi girip onaylayın.

    Şifreler en az 8 karakter uzunluğunda olmalı ve aşağıdakilerden en az birini içermelidir: sayı, küçük harf, büyük harf ve özel karakter.

  8. Yeni Şifre Oluştur'u tıklayın.

SAML kimlik doğrulamasını kullanarak portalda oturum açma (beta)

SAML kimlik sağlayıcı etkinleştirildiğinde portal kullanıcıları, entegre portalda SAML kimlik doğrulamasını kullanarak aşağıdaki şekilde oturum açar:

  1. Portala gidin.
  2. Oturum aç'ı tıklayın.

  3. SAML ile giriş yap'ı tıklayın.

    SAML sağlayıcıya yönlendirilirsiniz.

  4. İstenirse SAML kimlik sağlayıcınızın kimlik bilgilerini girin.

API referans dokümanlarını görüntüleme

Portal kullanıcıları, portalınızda yayınladığınız API referans dokümanlarını aşağıdaki gibi görüntüleyebilir:

  1. Portala gidin.

  2. Üst gezinme çubuğunda API'ler'i tıklayın. API'ler sayfası görüntülenir. Örneğin:

    API'ler sayfası

  3. Sol bölmede bulunan araçları kullanarak API listesini kategoriye, başlığa veya açıklamaya göre filtreleyin.

  4. API referans dokümanlarını görüntülemek için bir API kartını tıklayın. API referans dokümanları gösterilir.

Portal kullanıcıları API'ler hakkında bilgi edinip bunları deneyebilir veya API referans dokümanlarını oluşturmak için kullanılan dokümanı indirebilir. API referans dokümanlarının nasıl oluşturulduğu hakkında daha fazla bilgi için API'lerinizi yayınlama başlıklı makaleyi inceleyin.

Geliştirici ekiplerini kullanarak bir uygulamanın sorumluluğunu paylaşma (beta)

Geliştirici ekipleri, portal kullanıcılarının bir uygulamanın sorumluluğunu diğer portal kullanıcılarıyla paylaşmasına olanak tanır. Aşağıdaki bölümlerde, geliştirici ekiplerinin nasıl oluşturulacağı ve yönetileceği açıklanmaktadır.

Geliştirici ekibi rolleri hakkında

Aşağıdaki tabloda, geliştirici ekibi üyelerine atanabilecek roller özetlenmiştir:

Rol Açıklama
Uygulama Yöneticisi
  • Geliştirici ekibi üyeleri ve geliştirici ekibi ayrıntıları için salt okuma ayrıcalıkları.
  • Uygulamalar için okuma ve yazma ayrıcalıkları.
Sahip Geliştirici ekibi üyeleri, geliştirici ekibi ayrıntıları ve uygulamalar için tam okuma ve yazma ayrıcalıkları.
Görüntüleyen Geliştirici ekibi üyeleri, geliştirici ekibi ayrıntıları ve uygulamalar için salt okunur ayrıcalıklar.

Ekipler sayfasını görüntüleme

Ekipler sayfasında, üyesi olduğunuz geliştirici ekipleri gösterilir.

Ekipler sayfasına erişmek için:

  1. Portalda oturum açın.
  2. Portaldaki kullanıcı hesabı açılır menüsünden Ekipler'i seçin.

Ekipler sayfası görüntülenir. Bu sayfada şunları yapabilirsiniz:

Geliştirici ekipleri ekleme

Geliştirici ekibi eklemek için:

  1. Portalda oturum açın.
  2. Portaldaki kullanıcı hesabı açılır menüsünden Ekipler'i seçin.
  3. + Yeni Ekip'i tıklayın.
  4. Ad ve açıklama girin.

  5. Geliştirici ekibine üye eklemek için + Başka üye ekle'yi tıklayın, portal kullanıcısının e-posta adresini girin ve bir geliştirici ekibi rolü seçin.

    Başka üyeler eklemek için bu işlemi tekrarlayın.

  6. Geliştirici ekibinden bir üyeyi silmek için silmek istediğiniz geliştirici ekibi üyesinin yanındaki sil simgesi simgesini tıklayın.

  7. Oluştur'u tıklayın.

Geliştirici ekibi üyeliğini ve rollerini düzenleme

Geliştirici ekibi üyeliğini ve rollerini düzenlemek için:

  1. Portalda oturum açın.
  2. Portaldaki kullanıcı hesabı açılır menüsünden Ekipler'i seçin.
  3. Düzenlemek istediğiniz ve sahibi olduğunuz geliştirici ekibinin satırını tıklayın.

  4. Aşağıdaki adımlardan en az birini uygulayın:

    • Adı, açıklamayı ve birincil iletişim sorumlusunu düzenleyin.
    • Geliştirici ekibi üyelerini ekleme veya kaldırma.
    • Geliştirici ekibi üye rollerini güncelleyin.

  5. Kaydet'i tıklayın.

Kendinizi geliştirici ekibinden çıkarma

Kendinizi bir geliştirici ekibinden çıkarmak için:

  1. Portalda oturum açın.
  2. Portaldaki kullanıcı hesabı açılır menüsünden Ekipler'i seçin.
  3. Kendinizi kaldırmak istediğiniz geliştirici ekibinin satırını tıklayın.
  4. Ekipten Çık'ı tıklayın.

Geliştirici ekibini silme

Bir geliştirici ekibini silmek için:

  1. Portalda oturum açın.
  2. Portaldaki kullanıcı hesabı açılır menüsünden Ekipler'i seçin.
  3. Silmek istediğiniz geliştirici ekibinin satırını tıklayın.
  4. sil simgesi simgesini tıklayın.
  5. Silme işlemini onaylamak için Onayla'yı tıklayın.

Uygulamaları kaydetme

Aşağıdaki bölümlerde açıklandığı gibi geliştirici uygulamalarını ve geliştirici ekibi uygulamalarını kaydedin.

Geliştirici uygulamalarını kaydetme

Portal kullanıcıları, yayınladığınız API'leri kullanmak için aşağıdaki şekilde uygulama kaydedebilir:

  1. Kullanıcı hesabı açılır listesinden Uygulamalar'ı seçin.
  2. Yeni uygulama oluşturmak için + Yeni Uygulama'yı tıklayın.
  3. Yeni Uygulama iletişim kutusunda uygulama için bir ad ve açıklama girin.

  4. Sahip açılır listesinde uygulamanın sahibini seçin.

    Varsayılan olarak uygulamanın sahibi sizsiniz. İsterseniz uygulamanın sorumluluğunu diğer geliştirici ekip üyeleriyle paylaşmak için açılır menüden bir geliştirici ekibi seçin. Geliştirici ekiplerini kullanarak uygulama sorumluluğunu paylaşma (beta) başlıklı makaleyi inceleyin.

  5. API Kataloğu bölümünde bir veya daha fazla API seçin.

    Katalogdaki API'ler, geri çağırma URL'si gerektiren kimlik doğrulanmış API'ler veya herkese açık API'ler olarak sınıflandırılır. Uygulama oluşturmak için en az bir API seçmeniz gerekir.

  6. Kimlik doğrulanmış API'ler bölümünde bir API seçerseniz geri çağırma URL'si girin.

    Daha fazla bilgi için Geri arama URL'leri hakkında başlıklı makaleyi inceleyin.

  7. Oluştur'u tıklayın.

Geliştirici ekibi uygulamalarını kaydetme

Geliştirici ekibi üyeleri, aşağıda açıklandığı gibi, yayınladığınız API'leri kullanması için bir geliştirici ekibine uygulama kaydedebilir.

Aşağıdakiler hakkında daha fazla bilgi edinin:

Geliştirici ekibi uygulamalarını kaydetmek için:

  1. Kullanıcı hesabı açılır menüsünden Ekipler'i seçin.
  2. Uygulama kaydettirmek istediğiniz geliştirici ekibinin satırını tıklayın.
  3. Yeni uygulama oluşturmak için + Yeni Uygulama'yı tıklayın.
  4. Yeni Uygulama iletişim kutusunda uygulama için bir ad ve açıklama girin.

  5. Sahip açılır listesinde uygulamanın sahibini seçin.

    Varsayılan olarak, uygulamanın sahibi geliştirici ekibidir. Dilerseniz açılır menüden farklı bir geliştirici ekibini veya kendinizi sahip olarak seçin.

  6. API Kataloğu bölümünde bir veya daha fazla API seçin.

    Katalogdaki API'ler, geri çağırma URL'si gerektiren kimlik doğrulanmış API'ler veya herkese açık API'ler olarak sınıflandırılır. Uygulama oluşturmak için en az bir API seçmeniz gerekir.

  7. Kimlik doğrulanmış API'ler bölümünde bir API seçerseniz geri çağırma URL'si girin.

    Daha fazla bilgi için Geri arama URL'leri hakkında başlıklı makaleyi inceleyin.

  8. Oluştur'u tıklayın.

Uygulamadaki API'leri yönetme

API üreticisi olarak, portal kullanıcılarının API ürünlerinizi kullanabilmesi için API'leri yayınlarsınız.

Portal kullanıcıları, uygulamalarının kullandığı API'leri yönetir. API'ler uygulama ayrıntıları sayfasına eklenir. Bazı API'ler otomatik olarak onaylanmaz. Onay Bekliyor durumu, erişimi istenen ancak henüz verilmeyen bir API'yi gösterir.

Portal kullanıcıları, bir uygulamadaki API'leri portalınızdan aşağıdaki gibi yönetebilir:

  1. Kullanıcı hesabı açılır listesinden Uygulamalar'ı seçin.
  2. Listede uygulamayı tıklayın.
  3. Uygulamadan bir API'ye erişimi sırasıyla etkinleştirmek veya devre dışı bırakmak için API'ler bölümünde etkinleştirme simgesi veya devre dışı bırakma simgesi simgesini tıklayın.
  4. Kimlik doğrulaması yapılmış bir API için geri çağırma URL'sini gerektiği gibi ekleyin veya düzenleyin.

Bir uygulamanın API anahtarını ve gizli anahtarını görüntüleme

Portal kullanıcıları, bir uygulamanın API anahtarını portalınızdan aşağıdaki gibi yönetebilir:

  1. Kullanıcı hesabı açılır listesinden Uygulamalar'ı seçin.
  2. Listede uygulamayı tıklayın.
  3. API anahtarlarını API Anahtarları bölümünde görüntüleyin.
  4. API anahtarının durumunun Etkin olduğunu onaylayın. API anahtarınız için onay gerekiyorsa ve anahtarınız henüz onaylanmadıysa durum Onay Bekliyor olarak gösterilir.
  5. Gizli anahtarı görüntülemek için Gizli anahtarı göster'i tıklayın.
  6. Fare imlecini API anahtarının veya gizli anahtarın üzerine getirin ve panoya kopyalamak için sil-simgesi simgesini tıklayın.

Bir uygulamanın API anahtarını döndürme

Portal kullanıcıları, bir uygulamanın API anahtarını düzenli olarak veya olası bir sızıntıya ya da güvenlik ihlaline yanıt olarak değiştirebilir. Bir portal kullanıcısı API anahtarını değiştirdiğinde, orijinal anahtarla aynı API izinlerine sahip yeni bir API anahtarı oluşturulur. Orijinal API anahtarı, kullanımdan kaldırdığınız sırada etkin kalır. Bir uygulamanın API anahtarını iptal etme bölümünde açıklandığı gibi, kimlik bilgilerinin kabul edilmemesini önlemek için eski API anahtarını iptal etmeniz gerekir.

Portal kullanıcıları, bir uygulamanın API anahtarını portalınızdan aşağıdaki gibi değiştirebilir:

  1. Kullanıcı hesabı açılır listesinden Uygulamalar'ı seçin.
  2. Listede uygulamayı tıklayın.
  3. API Anahtarları bölümünde Anahtar Ekle'yi tıklayın.
  4. İşlemi onaylamak için iletişim kutusunda Onayla'yı tıklayın.
  5. İsteğe bağlı olarak, eski API anahtarını aşağıda açıklandığı şekilde iptal edin.

Bir uygulamanın API anahtarını iptal etme

Bir portal kullanıcısı, önceki bölümde açıklandığı gibi bir API anahtarını değiştirdiğinde, API anahtarı kullanımdan kaldırılırken etkin kalır. Kimlik bilgilerinin kabul edilmesini önlemek için API anahtarını iptal etmeniz gerekir.

Portal kullanıcıları, bir uygulamanın API anahtarını portalınızdan aşağıdaki şekilde iptal edebilir:

  1. Kullanıcı hesabı açılır listesinden Uygulamalar'ı seçin.
  2. Uygulamanın adını tıklayın.
  3. API Anahtarları bölümünde, iptal etmek istediğiniz API anahtarıyla ilişkili İşlemler sütununda iptal simgesi simgesini tıklayın.

  4. İşlemi onaylamak için Onayla'yı tıklayın.

    Anahtarın durumu İptal Edildi olarak güncellenir.

Uygulama ayrıntılarını düzenleme

Portal kullanıcıları uygulama ayrıntılarını aşağıdaki gibi düzenleyebilir:

  1. Kullanıcı hesabı açılır listesinden Uygulamalar'ı seçin.
  2. Listede uygulamayı tıklayın.
  3. Uygulama Ayrıntıları sekmesindeki Ad veya Açıklama alanlarını düzenleyin.
  4. Gerekirse uygulamadaki API'leri yönetin.
  5. Kaydet'i tıklayın.

Uygulama silme

Portal kullanıcıları, portalınızdan bir uygulamayı aşağıdaki şekilde silebilir:

  1. Kullanıcı hesabı açılır listesinden Uygulamalar'ı seçin.
  2. Listede uygulamayı tıklayın.
  3. DELETE'i (SİL) tıklayın.
  4. İşlemi onaylamak için Onayla'yı tıklayın.

Uygulama silinir ve Uygulamalar listesinden kaldırılır.