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

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

Geliştirici portalı, portal kullanıcılarınızın kullanıcı hesabı oluşturmasına, oturum açmasına ve API'lerinizi tüketecek uygulamaları yönetmesine olanak tanır.

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çma

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

Hem yerleşik hem de SAML kimlik sağlayıcılarını 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 portala giriş yapma

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 portala giriş yapabilir:

Entegre portalda kullanıcı hesabı oluşturma

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

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

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

    Oturum açma sayfası gösterilir.

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

    Hesabınızı oluşturma sayfası gösterilir.

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

  4. Formu doldurun.

    Tüm zorunlu alanlar için değer girmeniz gerekir. Şifreler en az 8 karakter olmalı ve aşağıdaki öğelerin her birinden en az bir tane içermelidir: rakam, 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österiliyorsa) tıklayın.

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

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

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

  9. Entegre portala (aşağıda açıklanmıştır) giriş yapın.

Entegre portalda oturum açma

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

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

  1. Portala gidin.
  2. Oturum aç'ı tıklayın. Oturum açma sayfası 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ıda portal kullanıcıları şifreyi aşağıdaki şekilde 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. Şifre Sıfırlama Bağlantısı Gönder'i tıklayın.

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

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

  7. Yeni şifreyi girin ve onaylayın.

    Şifreler en az 8 karakter olmalı ve aşağıdaki öğelerin her birinden en az bir tane içermelidir: rakam, küçük harf, büyük harf ve özel karakter.

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

SAML kimlik doğrulaması (beta) kullanarak portala giriş yapma

SAML kimlik sağlayıcı etkinleştirildiğinde portal kullanıcıları, entegre portala SAML kimlik doğrulaması kullanarak aşağıdaki şekilde giriş yapar:

  1. Portala gidin.
  2. Oturum aç'ı tıklayın.
  3. login with SAML'yi (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 belgelerini görüntüleme

Portal kullanıcıları, portalınızda yayınladığınız API referans belgelerini 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. İsterseniz sol bölmedeki araçları kullanarak API listesini kategoriye, başlığa veya açıklamaya göre filtreleyin.

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

Portal kullanıcıları API'ler hakkında bilgi edinebilir, API'leri deneyebilir veya API referans belgelerini oluşturmak için kullanılan dokümanı indirebilir. API referans belgelerinin 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 okunur 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. Portala oturum açın.
  2. Portaldaki kullanıcı hesabı açılır menüsünden Ekipler'i seçin.

Ekipler sayfası gösterilir. Bu sayfada şunları yapabilirsiniz:

Geliştirici ekipleri ekleme

Geliştirici ekibi eklemek için:

  1. Portala 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. Portala 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 birini veya daha fazlasını uygulayın:

    • Adı, açıklamayı ve öncelikli kişiyi düzenleyin.
    • Geliştirici ekibi üyesi ekleme veya kaldırma
    • Geliştirici ekibi üye rollerini güncelleme
  5. Kaydet'i tıklayın.

Kendinizi bir geliştirici ekibinden çıkarma

Kendinizi bir geliştirici ekibinden kaldırmak için:

  1. Portala 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 ayrıl'ı tıklayın.

Geliştirici ekibini silme

Geliştirici ekibini silmek için:

  1. Portala 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ığı şekilde 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 uygulamaları aşağıdaki şekilde kaydedebilir:

  1. Kullanıcı hesabı açılır listesinden Uygulamalar'ı seçin.
  2. Yeni bir 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 sizsinizdir. İsterseniz açılır menüden bir geliştirici ekibi seçerek uygulamayla ilgili sorumluluğu diğer geliştirici ekibi üyeleriyle paylaşabilirsiniz. Geliştirici ekiplerini kullanarak bir uygulamanın 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 Kimliği 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. Kimliği doğrulanmış API'ler bölümünde bir API seçerseniz geri çağırma URL'si girin.

    Daha fazla bilgi için Geri çağırma 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ığı şekilde, yayınladığınız API'leri kullanmak üzere geliştirici ekibi adına uygulamaları kaydedebilir.

Şu işlemlerin nasıl yapılacağı hakkında daha fazla bilgi edinmek için:

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

  1. Kullanıcı hesabı açılır listesinden Ekipler'i seçin.
  2. Uygulama kaydetmek istediğiniz geliştirici ekibinin satırını tıklayın.
  3. Yeni bir 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, geliştirici ekibi uygulamanın sahibidir. İsterseniz açılır menüden farklı bir geliştirici ekibi veya kendinizi sahip olarak seçebilirsiniz.

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

    Katalogdaki API'ler, geri çağırma URL'si gerektiren Kimliği 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. Kimliği doğrulanmış API'ler bölümünde bir API seçerseniz geri çağırma URL'si girin.

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

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

Bir uygulamadaki API'leri yönetme

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

Portal kullanıcıları, uygulamalarının hangi API'leri kullanacağını yönetir. API'ler, uygulama ayrıntıları sayfasına eklenir. Bazı API'ler için onay otomatik olarak verilmez. Onay Bekliyor durumu, erişim isteğinde bulunulan ancak henüz erişim izni verilmeyen bir API'yi gösterir.

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

  1. Kullanıcı hesabı açılır listesinden Uygulamalar'ı seçin.
  2. Listede uygulamayı tıklayın.
  3. API'ler bölümünde, uygulamadan bir API'ye erişimi etkinleştirmek veya devre dışı bırakmak için sırasıyla etkinleştirme simgesi veya devre dışı bırakma simgesi simgesini tıklayın.
  4. Kimliği doğrulanmış bir API için gerektiği şekilde geri çağırma URL'sini 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 şekilde 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 doğrulayın. API anahtarınızın onaylanması gerekiyorsa ve 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. İmlecinizi API anahtarının veya sırrının üzerine getirin ve delete-icon simgesini tıklayarak panoya kopyalayın.

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

Portal kullanıcısı, bir uygulamanın API anahtarını düzenli olarak veya olası bir sızıntı ya da güvenlik açığına yanıt olarak döndürebilir. Portal kullanıcısı bir API anahtarını döndürdüğünde, orijinal anahtarla aynı API yetkilerine sahip yeni bir API anahtarı oluşturulur. Kullanımdan kaldırma işlemi sırasında orijinal API anahtarı etkin kalır. Kimlik bilgilerinin kabul edilmesini önlemek için eski API anahtarını iptal etmeniz gerekir. Bu işlem, Bir uygulamanın API anahtarını iptal etme başlıklı makalede açıklanmıştır.

Portal kullanıcıları, portalınızdaki bir uygulamanın API anahtarını aşağıdaki şekilde döndürebilir:

  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 uygulama için API anahtarını iptal etme

Bir portal kullanıcısı, önceki bölümde açıklandığı gibi bir API anahtarını döndürdüğünde, API anahtarı kullanımdan kaldırılana kadar 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 etme 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 şekilde 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 bir uygulamadaki API'leri yönetin.
  5. Kaydet'i tıklayın.

Uygulama silme

Portal kullanıcıları, aşağıdaki adımları uygulayarak portalınızdan bir uygulamayı 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.