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

Kullanıma hazır geliştirici portalı, portal kullanıcılarınızın kullanıcı hesabı oluşturmasına, oturum açmasına ve API'lerinizi kullanacak 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çın

Aşağıdaki bölümlerde, portal kullanıcılarının entegre portalda kullanıcı kimlik bilgilerini (yerleşik kimlik sağlayıcı) veya SAML (beta) kullanarak nasıl oturum açtığı 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 portalda oturum açın

bölümünde açıklandığı gibi şirket logosunu değiştirmek dışında düzenlenemez.

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

Entegre portalda bir kullanıcı hesabı oluşturma

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

Portal kullanıcıları, entegre portalda aşağıdaki şekilde bir 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.

    Zorunlu tüm alanlar için değer girmeniz gerekir. Şifreler en az 8 karakterden oluşmalı ve şunlardan en az birini içermelidir: rakam, küçük harf, büyük harf ve özel karakter.

  5. Şartları inceleyin ve kabul edin.

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

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

    Kullanıcı hesabı oluşturulur ve 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, bir hesap oluşturmak için bu prosedürdeki adımları tekrarlamanız ve sizden tekrar onay istenmesi gerekir.

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

Entegre portalda oturum açın

Yerleşik kimlik sağlayıcı sayesinde, 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 şekilde oturum açar:

  1. Portala gidin.
  2. Oturum Aç'ı tıklayın. Oturum açma sayfasında şunlar görüntülenir: 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ı sayesinde 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-postaya bir şifre sıfırlama bağlantısı gönderilir.

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

  7. Yeni şifreyi girin ve onaylayın.

    Şifreler en az 8 karakterden oluşmalı ve şunlardan en az birini 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ını (beta) kullanarak portalda oturum açma

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. login with SAML (SAML ile giriş yap) seçeneğini tıklayın.

    SAML sağlayıcısına yönlendirilirsiniz.

  4. İstenirse SAML kimlik sağlayıcınıza ait kimlik bilgilerinizi girin.

API referans belgelerini görüntüleyin

Portal kullanıcıları, portalınıza yayınladığınız API referans belgelerini aşağıdaki şekilde görüntüleyebilir:

  1. Portala gidin.

  2. Üst gezinme çubuğunda API'ler seçeneğini 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 filtreleyebilirsiniz.

  4. API referans belgelerini 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 belgelerini oluşturmak için kullanılan belgeyi indirebilir. API referans belgelerinin nasıl oluşturulduğu hakkında daha fazla bilgi için API'lerinizi yayınlama bölümüne bakın.

Bir uygulamanın sorumluluğunu geliştirici ekiplerini kullanarak 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 ekibindeki roller hakkında

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

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 okuma ayrıcalıkları.

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

Ekipler sayfası, üyesi olduğunuz geliştirici ekiplerini gösterir.

Ekipler sayfasına erişmek için:

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

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

Geliştirici ekipleri ekleyin

Geliştirici ekibi eklemek için:

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

  5. Geliştirici ekibine bir üye eklemek için + Başka üye ekle'yi tıklayın, portal kullanıcısının e-posta adresini girin ve 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. Create'i (Oluştur) tıklayın.

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

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 Teams'i (Ekipler) seçin.
  3. Düzenlemek istediğiniz ve sahibi olduğunuz geliştirici ekibi 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 üyelerini ekleyin veya kaldırın.
    • Geliştirici ekibi üyesi rollerini güncelleme.

  5. Kaydet'i tıklayın.

Kendinizi bir geliştirici ekibinden kaldırma

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

  1. Portalda oturum açın.
  2. Portaldaki kullanıcı hesabı açılır menüsünden Teams'i (Ekipler) seçin.
  3. Kendinizi çıkarmak istediğiniz geliştirici ekibinin satırını tıklayın.
  4. Ekipten Ayrıl'ı 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 Teams'i (Ekipler) 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ı kaydet

Geliştirici uygulamalarını ve geliştirici ekibi uygulamalarını aşağıdaki bölümlerde açıklandığı şekilde 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 menüsünden Apps'i (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 listesinden Uygulamanın sahibini seçin.

    Varsayılan olarak, uygulamanın sahibi sizsinizdir. İsterseniz, uygulamanın sorumluluğunu diğer geliştirici ekibi üyeleriyle paylaşmak için açılır menüden bir geliştirici ekibi seçin. Geliştirici ekiplerini kullanarak bir uygulamanın sorumluluğunu paylaşma (beta) bölümünü 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 Genel API'ler olarak sınıflandırılır. Uygulama oluşturmak için en az bir API seçmelisiniz.

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

    Daha fazla bilgi için Geri çağırma URL'leri hakkında konusuna bakın.

  7. Create'i (Oluştur) tıklayın.

Geliştirici ekibi uygulamalarını kaydedin

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

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 menüsünden Teams'i (Ekipler) 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 listesinden Uygulamanın sahibini seçin.

    Varsayılan olarak uygulamanın sahibi geliştirici ekibidir. İsterseniz açılır menüden farklı bir geliştirici ekibi veya sahip olarak kendinizi 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 Kimliği Doğrulanmış API'ler veya Genel API'ler olarak sınıflandırılır. Uygulama oluşturmak için en az bir API seçmelisiniz.

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

    Daha fazla bilgi için Geri çağırma URL'leri hakkında konusuna bakın.

  8. Create'i (Oluştur) tıklayın.

Bir uygulamadaki API'leri yönetme

Bir API üreticisi olarak, portal kullanıcılarının API ürünlerinizi tüketmelerini sağlamak için API'leri 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'lerde onay işlemi otomatik değildir. Onay Bekliyor durumu, erişim istenen ancak henüz verilmemiş bir API'yi belirtir.

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

  1. Kullanıcı hesabı açılır menüsünden Apps'i (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ştir simgesi veya devre dışı bırak simgesi seçeneğini tıklayın.
  4. Kimlik Doğrulaması Yapılmış API için geri çağırma URL'sini gerektiği gibi ekleyin veya düzenleyin.

Bir uygulamanın API anahtarını ve sırrı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 menüsünden Apps'i (Uygulamalar) seçin.
  2. Listede uygulamayı tıklayın.
  3. API Anahtarları bölümünde API anahtarlarını görüntüleyin.
  4. API anahtarının durumunun Etkin olduğunu onaylayın. API anahtarınız onay gerektiriyorsa ve henüz onaylanmadıysa, 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 gizli anahtarın üzerine getirin ve sil-simgesi işaretini tıklayarak panoya kopyalayın.

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

Portal kullanıcıları, bir uygulamanın API anahtarını periyodik olarak veya olası bir sızıntı ya da güvenlik ihlaline karşı değiştirebilir. Bir portal kullanıcısı bir API anahtarını döndürdüğünde orijinal anahtarla aynı API yetkilerine sahip yeni bir API anahtarı oluşturulur. Orijinal API anahtarı, kullanımdan kaldırıldığı sürece etkin kalır. Kimlik bilgilerinin kabul edilmesini önlemek için eski API anahtarını iptal etmeniz gerekir (Uygulamaya ilişkin API anahtarını iptal etme bölümünde açıklandığı gibi).

Portal kullanıcıları, portalınızdaki bir uygulamanın API anahtarına aşağıdaki şekilde rotasyon uygulayabilir:

  1. Kullanıcı hesabı açılır menüsünden Apps'i (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, aşağıda açıklandığı şekilde eski API anahtarını 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ı döndürdüğünde, API anahtarı siz kullanımdan kaldırırken etkin kalır. Kimlik bilgilerinin kabul edilmesini önlemek için API anahtarını iptal etmeniz gerekir.

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

  1. Kullanıcı hesabı açılır menüsünden Apps'i (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'yi 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üzenle

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

  1. Kullanıcı hesabı açılır menüsünden Apps'i (Uygulamalar) seçin.
  2. Listede uygulamayı tıklayın.
  3. Uygulama Ayrıntıları sekmesinde Ad veya Açıklama alanlarını düzenleyin.
  4. Gerektiği şekilde bir uygulamadaki API'leri yönetme.
  5. Kaydet'i tıklayın.

Uygulama silme

Portal kullanıcıları aşağıdaki işlemleri yaparak bir uygulamayı portalınızdan silebilir:

  1. Kullanıcı hesabı açılır menüsünden Apps'i (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.