Ortak Portal
AI Agent ile inşa et
API Ortak Portalı Arka Ucu

API Ortak Portalı Arka Uç Şablonu
Ortak Erişimi, API Trafiği ve Dokümantasyon

Back4app üzerinde üretime hazır API ortak portal arka ucu: Kullanıcı, PartnerOrganizasyon, API Anahtar, Kullanım Günlüğü ve Geliştirici Dokümanı ile birlikte. ER diyagramı, veri sözlüğü, JSON şeması, API oyun alanı ve hızlı kurulum için bir Yapay Zeka Ajanı istemi içerir.

Portal İpuçları

Bu şablon, iç ekiplerin ve harici ortakların tek bir çalışma yüzeyini paylaşabilmesi için APIKey yönetimi, UsageLog incelemesi ve DeveloperDoc yayımlama işlemleri ile bir API ortak portal arka ucu sağlar.

  1. APIKey yaşam döngüsü kontrolüOrtak mülkiyeti, tokenPrefix, kapsamlar, isActive ve lastUsedAt alanları ile APIKey kayıtlarını modelleyin.
  2. UsageLog görünürlüğüEndpoint çağrılarını, statusCode zirvelerini ve requestCount toplamlarını gözden geçirebilmeniz için her apiKey başına UsageLog girişlerini izleyin.
  3. DeveloperDoc güncellemeleriBaşlık, slug, içerik, apiVersion ve isPublished kullanarak DeveloperDoc kayıtlarını yayımlanan API yönergeleri ile uyumlu tutun.
  4. Ortak erişim sınırlarıOrtakOrganizasyon çalışma alanlarını, APIAnahtar satırlarını ve KullanımKaydı kayıtlarını doğru hesaba göre sınırlandırmak için ACL'ler ve CLP'ler kullanın.
  5. Çoklu platform portal arka uçKullanıcı, OrtakOrganizasyon, APIAnahtar, KullanımKaydı ve GeliştiriciDokümanı için tek bir REST ve GraphQL API üzerinden web ve mobil istemcilere hizmet verin.

API Ortak Portal Şablonu Nedir?

API ortak portalında izinler önemlidir: ortaklar, personel ve müşteriler, rollerinin gerektirdiği şeyleri tam olarak görmelidir — ne fazla, ne de eksik. Güvenilirlik bir özelliktir, dipnot değil. Bu şablon, her API ortak portal takım üyesinin sahip olduğu boru hattı dilimini görmesi için Back4app üzerinde rol tabanlı erişim ile OrtakOrganizasyon, APIAnahtar, KullanımKaydı ve GeliştiriciDokümanı modeller.

En iyi için:

API ortak portallarıAPI Anahtar yaşam döngüsü panolarıKullanım Kaydı analitik konsollarıGeliştirici Dokümanı yayınlama merkezleriB2B entegrasyonlarıTakımların BaaS'ı paylaşılan API erişimi için seçmesi

API Ortak Portalı şablonuna genel bakış

Çoğu API ortak portal hatası sıkıcıdır: kaçırılan bir zaman damgası, tekrar eden bir satır veya dün doğru olan ama bugün yanlış olan bir sayı.

PartnerOrganization, APIKey ve UsageLog arkasındaki şema, merkezler ve teknik sayfalar arasında paylaşılır; çerçeve değiştirmek kayıtları yeniden tasarlamak anlamına gelmemelidir.

Portal Temel Özellikleri

Bu merkezdeki her teknoloji kartı, Kullanıcı, OrtakOrganizasyonu, APIAnahtarı, KullanımGünlüğü ve GeliştiriciBelgesi ile aynı ortak portal arka uç şemasını kullanır.

Ortak hesap yönetimi

OrtakOrganizasyon, bir kayıtta ad, durum, anaKişi ve destekDüzeyi tutar.

APIAnahtar yaşam döngüsü takibi

APIAnahtar, anahtarAdı, jetonÖneki, kapsamlar, aktifMi, enSonKullanıldığıZaman, ortak ve oluşturulandır bilgilerini saklar.

Kullanım Günlüğü incelemesi

Kullanım Günlüğü ortak, apiAnahtarı, uç nokta, yöntem, durumKodu, istekSayısı ve meydanaGeldiğiZaman'ı yakalar.

Geliştirici Belgesi yayımlama

Geliştirici Belgesi başlık, slug, içerik, apiVersiyonu, yayımlandı mı, sahip ve ortak bilgilerini saklar.

Neden Back4app ile API Partner Portal Backend'inizi Oluşturmalısınız?

Back4app, ekibinizin backend tesisatı yerine portal deneyimine odaklanabilmesi için User, PartnerOrganization, APIKey, UsageLog ve DeveloperDoc temel bileşenlerini sağlar.

  • Token ve partner yönetimi: APIKey, PartnerOrganization ile doğrudan bağlantılıdır, bu da verilmesini, döndürülmesini ve devre dışı bırakılmasını denetlemeyi kolaylaştırır.
  • Gerçek sorulara cevap veren kullanım görünürlüğü: UsageLog, destek ekibinin tahminde bulunmadan bir entegrasyon sorununu izleyebilmesi için endpoint, method, statusCode ve requestCount kaydeder.
  • Yayınlama darboğazı olmadan doküman güncellemeleri: DeveloperDoc, endpoint notları, sürümlenmiş rehberlik ve partner odaklı değişiklik geçmişi için yapılandırılmış bir alan sunar.

Partner onboarding'inin net bir backend sözleşmesine sahip olması için önce APIKey, UsageLog ve DeveloperDoc etrafında portalı inşa edin.

Portal Faydaları

APIAnahtarı işleri, Kullanım Günlüğü incelemesi ve Geliştirici Belgesi yayımlamayı tek bir yerde tutan bir ortak portal arka ucu.

Daha hızlı ortak onboarding

Token tablolarını ve erişim kurallarını sıfırdan oluşturmaktansa PartnerOrganization ve APIKey sınıflarıyla başlayın.

Destek ekipleri kullanılabilir bağlam alır

UsageLog satırları, bir partner bir başarısız istek bildirdiğinde nokta, yöntem, durum kodu, istek sayısı ve oluşma zamanını gösterir.

Daha güvenli anahtar yönetimi

Ham sırları ifşa etmek yerine tokenPrefix ve kapsamları saklayın ve bir anahtar durum değiştirdiğinde isActive'ı değiştirin.

Sürüm numaralı belgeler düzenli kalır

DeveloperDoc, sürüm notları, apiVersion hedeflemesi ve yayın durumuna sabit bir yapı sağlar.

Her müşteri için tek API yüzeyi

Web portalları, mobil yönetim araçları ve dahili panolar aynı Kullanıcı, PartnerOrganization, APIKey, UsageLog ve DeveloperDoc verilerini okuyabilir.

AI bootstrap iş akışı

Yapıyı hızlı bir şekilde oluşturmak için şema, erişim kuralları ve portal iskeletini tek bir yapılandırılmış istemle oluşturun.

API ortak portalınızı başlatmaya hazır mısınız?

Back4app AI Ajanının API ortak portal arka ucunu oluşturmasına ve tek bir istemden APIKey, UsageLog ve DeveloperDoc akışlarını üretmesine izin verin.

Başlamak için ücretsiz - ayda 50 AI Ajan istemi, kredi kartı gerekli değil

Portal Teknoloji Yığını

Bu API ortak portal arka uç şablonuna dahil olan her şey.

Ön Uç
13+ teknoloji
Arka Uç
Back4app
Veritabanı
MongoDB
Kimlik Doğrulama
Yerleşik kimlik doğrulama + oturumlar
API
REST ve GraphQL
Gerçek zamanlı
Live Queries

Ortak İlişki Haritası

API ortak portal arka uç şeması için varlık ilişkisi modeli.

Diyagram kaynağını görüntüle
Mermaid
erDiagram
    User ||--o{ PartnerOrganization : "primaryContact"
    User ||--o{ APIKey : "createdBy"
    User ||--o{ DeveloperDoc : "owner"
    PartnerOrganization ||--o{ APIKey : "partner"
    PartnerOrganization ||--o{ UsageLog : "partner"
    PartnerOrganization ||--o{ DeveloperDoc : "partner"
    APIKey ||--o{ UsageLog : "apiKey"

    User {
        String objectId PK
        String username
        String email
        String password
        String role
        Date createdAt
        Date updatedAt
    }

    PartnerOrganization {
        String objectId PK
        String name
        String status
        String primaryContactId FK
        String supportTier
        Date createdAt
        Date updatedAt
    }

    APIKey {
        String objectId PK
        String keyName
        String tokenPrefix
        Array scopes
        Boolean isActive
        Date lastUsedAt
        String partnerId FK
        String createdById FK
        Date createdAt
        Date updatedAt
    }

    UsageLog {
        String objectId PK
        String partnerId FK
        String apiKeyId FK
        String endpoint
        String method
        Number statusCode
        Number requestCount
        Date occurredAt
        Date createdAt
        Date updatedAt
    }

    DeveloperDoc {
        String objectId PK
        String title
        String slug
        String content
        String apiVersion
        Boolean isPublished
        String ownerId FK
        String partnerId FK
        Date createdAt
        Date updatedAt
    }

Portal Entegrasyon Akışı

Oturum açma, API Anahtarı arama, Kullanım Kaydı inceleme ve Geliştirici Doküman güncellemeleri için tipik çalışma akışı.

Diyagram kaynağını görüntüle
Mermaid
sequenceDiagram
  participant User
  participant Portal as API Partner Portal App
  participant Back4app as Back4app Cloud

  User->>Portal: Sign in with portal credentials
  Portal->>Back4app: POST /login
  Back4app-->>Portal: Session token

  User->>Portal: Open APIKeys for a partner workspace
  Portal->>Back4app: GET /classes/APIKey?include=partner,createdBy
  Back4app-->>Portal: Token list with scopes and lastUsedAt

  User->>Portal: Create a new APIKey
  Portal->>Back4app: POST /classes/APIKey
  Back4app-->>Portal: APIKey objectId and tokenPrefix

  User->>Portal: Review UsageLog entries for the token
  Portal->>Back4app: GET /classes/UsageLog?include=partner,apiKey&order=-occurredAt
  Back4app-->>Portal: Usage history and statusCode totals

  opt Publish developer notes
    User->>Portal: Update a DeveloperDoc page
    Portal->>Back4app: PUT /classes/DeveloperDoc/:objectId
    Back4app-->>Portal: Updated markdown and publish state
  end

Alan Sözlüğü

API ortak portal şemasındaki her sınıf için tam alan düzeyi referansı.

AlanTürAçıklamaGerekli
objectIdStringAuto-generated unique identifierOtomatik
usernameStringLogin name for a portal user
emailStringPrimary email address for portal access
passwordStringHashed password (write-only)
roleStringPortal role such as admin, partnerAdmin, or developer
createdAtDateAuto-generated creation timestampOtomatik
updatedAtDateAuto-generated last-update timestampOtomatik

7 alanları User

Erişim Kontrolleri

ACL ve CLP stratejisi, ortakları, APIKey kayıtlarını, UsageLog girişlerini ve DeveloperDoc sayfalarını nasıl korur.

Ortak kapsamlı hesaplar

Her PartnerOrganization kaydı yalnızca portal yöneticileri veya atanmış birincil İletişim Kullanıcısı tarafından düzenlenebilir.

Anahtar gizliliği ve döngüsü

APIKey.tokenPrefix ve kapsamlarını genel görüntülerde saklayın ve ham anahtar materyalini tarayıcıdan uzak tutun.

Kullanım günlüğü okuma sınırları

Kullanım Günlüğü okumalarını, APIKey'in sahibi olan ortak ile sorun giderme erişimine ihtiyaç duyan destek rolleri ile sınırlayın.

JSON Şeması

Back4app'a kopyalamak veya uygulama referansı olarak kullanmak için hazır ham JSON şeması tanımı.

JSON
{
  "classes": [
    {
      "className": "User",
      "fields": {
        "objectId": {
          "type": "String",
          "required": false
        },
        "username": {
          "type": "String",
          "required": true
        },
        "email": {
          "type": "String",
          "required": true
        },
        "password": {
          "type": "String",
          "required": true
        },
        "role": {
          "type": "String",
          "required": true
        },
        "createdAt": {
          "type": "Date",
          "required": false
        },
        "updatedAt": {
          "type": "Date",
          "required": false
        }
      }
    },
    {
      "className": "PartnerOrganization",
      "fields": {
        "objectId": {
          "type": "String",
          "required": false
        },
        "name": {
          "type": "String",
          "required": true
        },
        "status": {
          "type": "String",
          "required": true
        },
        "primaryContact": {
          "type": "Pointer",
          "required": true,
          "targetClass": "User"
        },
        "supportTier": {
          "type": "String",
          "required": false
        },
        "createdAt": {
          "type": "Date",
          "required": false
        },
        "updatedAt": {
          "type": "Date",
          "required": false
        }
      }
    },
    {
      "className": "APIKey",
      "fields": {
        "objectId": {
          "type": "String",
          "required": false
        },
        "keyName": {
          "type": "String",
          "required": true
        },
        "tokenPrefix": {
          "type": "String",
          "required": true
        },
        "scopes": {
          "type": "Array",
          "required": true
        },
        "isActive": {
          "type": "Boolean",
          "required": true
        },
        "lastUsedAt": {
          "type": "Date",
          "required": false
        },
        "partner": {
          "type": "Pointer",
          "required": true,
          "targetClass": "PartnerOrganization"
        },
        "createdBy": {
          "type": "Pointer",
          "required": true,
          "targetClass": "User"
        },
        "createdAt": {
          "type": "Date",
          "required": false
        },
        "updatedAt": {
          "type": "Date",
          "required": false
        }
      }
    },
    {
      "className": "UsageLog",
      "fields": {
        "objectId": {
          "type": "String",
          "required": false
        },
        "partner": {
          "type": "Pointer",
          "required": true,
          "targetClass": "PartnerOrganization"
        },
        "apiKey": {
          "type": "Pointer",
          "required": true,
          "targetClass": "APIKey"
        },
        "endpoint": {
          "type": "String",
          "required": true
        },
        "method": {
          "type": "String",
          "required": true
        },
        "statusCode": {
          "type": "Number",
          "required": true
        },
        "requestCount": {
          "type": "Number",
          "required": true
        },
        "occurredAt": {
          "type": "Date",
          "required": true
        },
        "createdAt": {
          "type": "Date",
          "required": false
        },
        "updatedAt": {
          "type": "Date",
          "required": false
        }
      }
    },
    {
      "className": "DeveloperDoc",
      "fields": {
        "objectId": {
          "type": "String",
          "required": false
        },
        "title": {
          "type": "String",
          "required": true
        },
        "slug": {
          "type": "String",
          "required": true
        },
        "content": {
          "type": "String",
          "required": true
        },
        "apiVersion": {
          "type": "String",
          "required": true
        },
        "isPublished": {
          "type": "Boolean",
          "required": true
        },
        "owner": {
          "type": "Pointer",
          "required": true,
          "targetClass": "User"
        },
        "partner": {
          "type": "Pointer",
          "required": false,
          "targetClass": "PartnerOrganization"
        },
        "createdAt": {
          "type": "Date",
          "required": false
        },
        "updatedAt": {
          "type": "Date",
          "required": false
        }
      }
    }
  ]
}

Yapay Zeka Ajanı ile Oluştur

Back4app Yapay Zeka Ajanı'nı kullanarak bu şablondan gerçek bir API ortak portal uygulaması oluşturun, ön uç, arka uç, kimlik doğrulama ve APIKey, Kullanım Günlüğü ve Geliştirici Dokümanı akışlarını içeren.

Back4app Yapay Zeka Ajanı
Oluşturmak için hazır
Back4app üzerinde bu tam şemayı ve davranışları kullanarak bir API ortak portali uygulama arka ucunu oluşturun.

Şema:
1. Kullanıcı: kullanıcı adı (Dize, gereklidir), e-posta (Dize, gereklidir), şifre (Dize, gereklidir), rol (Dize, gereklidir); objectId, createdAt, updatedAt (sistem).
2. OrtakKuruluş: isim (Dize, gereklidir), durum (Dize, gereklidir), birincilİletişim (Kullanıcıya işaretçi, gereklidir), destekAşaması (Dize, isteğe bağlı); objectId, createdAt, updatedAt (sistem).
3. APIAnahtarı: anahtarAdı (Dize, gereklidir), jetonÖneki (Dize, gereklidir), kapsamlar (Dizi<Dize>, gereklidir), aktifMi (Boolean, gereklidir), sonKullanımTarihi (Tarih, isteğe bağlı), ortak (OrtakKuruluşa işaretçi, gereklidir), oluşturan (Kullanıcıya işaretçi, gereklidir); objectId, createdAt, updatedAt (sistem).
4. KullanımKaydı: ortak (OrtakKuruluşa işaretçi, gereklidir), apiKey (APIAnahtarına işaretçi, gereklidir), uçnokta (Dize, gereklidir), yöntem (Dize, gereklidir), durumKodu (Sayı, gereklidir), istekSayısı (Sayı, gereklidir), gerçekleştiğiTarih (Tarih, gereklidir); objectId, createdAt, updatedAt (sistem).
5. GeliştiriciBelgeleri: başlık (Dize, gereklidir), slug (Dize, gereklidir), içerik (Dize, gereklidir), apiVersiyonu (Dize, gereklidir), yayımlandı mı (Boolean, gereklidir), sahip (Kullanıcıya işaretçi, gereklidir), ortak (OrtakKuruluşa işaretçi, isteğe bağlı); objectId, createdAt, updatedAt (sistem).

Güvenlik:
- Sadece portal yöneticileri veya atanmış sahipler ortak verilerini güncelleyebilir. Sadece onaylı roller APIAnahtarı kayıtları oluşturabilir, döndürebilir veya iptal edebilir. KullanımKaydı okumalarını sahip ortak ve destek rollerine kısıtlayın.

Kimlik Doğrulama:
- Kaydolma, giriş, çıkış.

Davranış:
- Ortakları listeleyin, APIAnahtarı kayıtları oluşturun ve döndürün, KullanımKaydı girişlerini gözden geçirin ve GeliştiriciBelgeleri sayfalarını yayınlayın.

Teslimat:
- Back4app uygulamasıyla şema, ACL'ler, CLP'ler; ortak hesapları için ön uç, API anahtarı yönetimi, kullanım kayıtları ve geliştirici belgeleri.

Bu şablon istemi önceden doldurulmuş olarak Ajan'ı açmak için aşağıdaki düğmeye basın.

Bu, teknoloji son ekine sahip temel istemdir. Oluşturulan ön uç yığınını sonradan uyarlayabilirsiniz.

Dakikalar içinde dağıtAylık 50 ücretsiz istemKredi kartı gerektirmiyor

API Oyun Alanı

API ortak portalı şemasına karşı REST ve GraphQL uç noktalarını deneyin. Yanıtlar sahte veriler kullanır ve Back4app hesabı gerektirmiyor.

Oyun alanı yükleniyor…

Bu şemayı kullanan aynı şablondur.

Yığınınızı Seçin

Her kartı genişleterek PartnerOrganization, APIKey ve UsageLog'u seçtiğiniz yığınla nasıl entegre edeceğinizi görün.

Flutter API Ortak Portal Arka Uç

React API Ortak Portal Arka Uç

React Yerel API Ortak Portal Arka Uç

Next.js API Ortak Portal Arka Uç

JavaScript API Ortak Portal Arka Uç

Android API Ortak Portal Arka Uç

iOS API Ortak Portal Arka Uç

Vue API Ortak Portal Arka Uç

Angular API Ortak Portal Arka Uç

GraphQL API Ortak Portal Arka Uç

REST API API Ortak Portal Arka Uç

PHP API Ortak Portal Arka Uç

.NET API Ortak Portal Arka Uç

Her Teknolojide Neleri Alırsınız

Her yığın, aynı API partner portal backend şemasını ve API sözleşmelerini kullanır.

Birleştirilmiş portal veri yapısı

Kullanıcı, PartnerOrganization, APIKey, UsageLog ve DeveloperDoc kayıtlarını tek bir tutarlı şema ile yönetin.

API anahtarı yaşam döngüsü kontrolü

APIKey kayıtlarını sahiplik izini kaybetmeden verin, döndürün ve iptal edin.

Destek ekipleri için kullanım görünürlüğü

Ortakların yardıma ihtiyaç duyduğunda kullanım günlüklerini uç nokta, yöntem ve durum koduna göre inceleyin.

Dokümantasyon sürüm takibi

Ortak geliştiriciler için apiVersion'a özel notlarla Geliştirici Dökümanı güncellemelerini yayınlayın.

Portal istemcileri için REST/GraphQL API'leri

İç yönetim araçlarını ve ortaklara yönelik uygulamaları tek bir API katmanı üzerinden sunun.

Ortak iş akışları için genişletilebilir mimari

Portal çekirdeğini yeniden yazmadan duyurular veya webhook abonelikleri gibi sınıflar ekleyin.

Portal Yığını Karşılaştırması

Tüm desteklenen teknolojilerde kurulum hızını, SDK stilini ve AI desteğini karşılaştırın.

ÇerçeveKurulum SüresiPortal FaydasıSDK TürüYapay Zeka Desteği
Yaklaşık 5 dakikaMobil ve web için ortak portalda tek kod tabanı.Yazılı SDKTam
5 dakikadan azOrtak anahtarlar ve günlükler için hızlı web kontrol paneli.Yazılı SDKTam
~3–7 dkOrtak destek için çoklu platform mobil uygulaması.Yazılı SDKTam
Hızlı (5 dk) kurulumAnahtarlar ve belgeler için sunucu tarafından işlenen yönetici portalı.Yazılı SDKTam
~3–5 dkOrtak operasyonları için hafif web entegrasyonu.Yazılı SDKTam
Yaklaşık 5 dkOrtak operasyonları için yerel Android uygulaması.Yazılı SDKTam
5 dakikadan azOrtak operasyonları için yerel iOS uygulaması.Yazılı SDKTam
~3–7 dkReactif anahtar inceleme ve belgeler için web UI.Yazılı SDKTam
Hızlı (5 dk) kurulumErişim ve kullanım incelemesi için kurumsal portal.Yazılı SDKTam
2 dakika altındaOrtak portal için esnek GraphQL API.GraphQL APITam
Hızlı (2 dk) kurulumOrtak portal için REST API entegrasyonu.REST APITam
~3 dkOrtak portal için sunucu tarafı PHP arka ucu.REST APITam
~3–7 dkOrtak portal için .NET arka ucu.Yazılı SDKTam

Kurulum süresi, bu şablon şemasını kullanarak projenin başlatılmasından ilk PartnerOrganization, APIKey veya UsageLog sorgusuna kadar beklenen süreyi yansıtır.

Portal Soruları

Bu şablonla bir API ortak portal arka uç oluşturma hakkında sıkça sorulan sorular.

Çalışmanın hassas ve son tarih odaklı olduğu bir durumda sağlıklı bir API ortak portalı hattı nasıl görünür?
Hangi API ortak portalı iş akışları yapılandırılmış görevlerden ziyade serbest notlardan en fazla faydayı sağlar?
Erişim modeli, API ortak portalı ortakları ve yüklenicileri için yeterince ince ayarlanmış mı?
Flutter ile anahtarlar ve günlükler için sorguları nasıl çalıştırırım?
API ortak portal erişimini Next.js Server Actions ile nasıl yönetebilirim?
React Native önbellek kullanım kayıtları çevrimdışı olabilir mi?
Yetkisiz anahtar erişimini nasıl önlerim?
Android üzerinde ortak kullanımını göstermek için en iyi yol nedir?
API anahtarı döngüsü nasıl çalışır?

Dünya genelindeki geliştiriciler tarafından güvenilir

Back4app şablonları ile API ortak portal ürünlerini daha hızlı gönderen ekiplere katılın.

G2 Users Love Us Badge

API Ortak Portal Uygulamanızı Oluşmaya Hazır Mısınız?

Ortak portal projenize dakikalar içinde başlayın. Kredi kartı gerekmez.

Teknolojiyi Seç