Template Backend Portal Mitra API
Akses Mitra, Lalu Lintas API, dan Dokumentasi
Backend portal mitra API yang siap produksi API partner portal backend di Back4app dengan User, PartnerOrganization, APIKey, UsageLog, dan DeveloperDoc. Termasuk diagram ER, kamus data, skema JSON, playground API, dan prompt AI Agent untuk pengaturan cepat.
Poin Penting Portal
Template ini memberikan Anda backend portal mitra API dengan manajemen APIKey, tinjauan UsageLog, dan penerbitan DeveloperDoc sehingga tim internal dan mitra eksternal berbagi satu permukaan kerja.
- Kontrol siklus hidup APIKey — Model catatan APIKey dengan kepemilikan mitra, tokenPrefix, scopes, isActive, dan fields lastUsedAt.
- Visibilitas UsageLog — Lacak entri UsageLog per apiKey sehingga Anda dapat meninjau panggilan endpoint, lonjakan statusCode, dan total requestCount.
- Pembaruan DeveloperDoc — Jaga catatan DeveloperDoc tetap selaras dengan panduan API yang diterbitkan menggunakan judul, slug, konten, apiVersion, dan isPublished.
- Batas akses Mitra — Gunakan ACL dan CLP untuk menjaga workspace PartnerOrganization, baris APIKey, dan catatan UsageLog agar sesuai dengan akun yang tepat.
- Backend portal lintas platform — Layani klien web dan mobile melalui satu API REST dan GraphQL untuk User, PartnerOrganization, APIKey, UsageLog, dan DeveloperDoc.
Apa itu Template Portal Mitra API?
Izin penting dalam portal mitra API: mitra, staf, dan klien seharusnya melihat dengan tepat apa yang dibutuhkan peran mereka — tidak lebih, tidak kurang. Keandalan adalah fitur, bukan catatan kaki. Template ini memodelkan PartnerOrganization, APIKey, UsageLog, dan DeveloperDoc dengan akses berbasis peran di Back4app sehingga setiap rekan tim portal mitra API melihat bagian dari pipeline yang mereka miliki. Skema mencakup User (username, email, password, role), PartnerOrganization (nama, status, primaryContact, supportTier), APIKey (keyName, tokenPrefix, scopes, isActive, lastUsedAt, partner, createdBy), UsageLog (partner, apiKey, endpoint, method, statusCode, requestCount, occurredAt), dan DeveloperDoc (judul, slug, konten, apiVersion, isPublished, pemilik, partner) dengan otorisasi, aturan visibilitas, dan dukungan alur kerja mitra yang terintegrasi. Hubungkan frontend pilihan Anda dan kirim lebih cepat.
Terbaik untuk:
Panduan umum template Portal Mitra API
Sebagian besar kesalahan portal mitra API membosankan: cap waktu yang terlewat, baris yang digandakan, atau jumlah yang benar kemarin dan salah hari ini.
Skema di balik PartnerOrganization, APIKey, dan UsageLog dibagikan di seluruh pusat dan halaman teknis; beralih kerangka kerja seharusnya tidak berarti meredesain catatan.
Fitur Inti Portal
Setiap kartu teknologi di hub ini menggunakan skema backend portal mitra yang sama dengan User, PartnerOrganization, APIKey, UsageLog, dan DeveloperDoc.
Manajemen akun mitra
PartnerOrganization menyimpan nama, status, kontakUtama, dan tingkatDukungan dalam satu rekaman.
Pelacakan siklus hidup APIKey
APIKey menyimpan keyName, tokenPrefix, scopes, isActive, lastUsedAt, partner, dan createdBy.
Tinjauan UsageLog
UsageLog menangkap mitra, apiKey, endpoint, method, statusCode, requestCount, dan occurredAt.
Publikasi DeveloperDoc
DeveloperDoc menyimpan judul, slug, konten, apiVersion, isPublished, pemilik, dan mitra.
Mengapa Membangun Backend Portal Mitra API Anda dengan Back4app?
Back4app memberi Anda User, PartnerOrganization, APIKey, UsageLog, dan DeveloperDoc primitif sehingga tim Anda dapat fokus pada pengalaman portal alih-alih plumbing backend.
- •Manajemen token dan mitra: APIKey langsung terhubung ke PartnerOrganization, menjadikan penerbitan, rotasi, dan deaktivasi lebih mudah diaudit.
- •Visibilitas penggunaan yang menjawab pertanyaan nyata: UsageLog mencatat endpoint, method, statusCode, dan requestCount sehingga dukungan dapat melacak masalah integrasi tanpa harus menebak.
- •Pembaruan dokumen tanpa kendala penerbitan: DeveloperDoc memberi Anda tempat terstruktur untuk catatan endpoint, panduan yang terverifikasi, dan riwayat perubahan yang terlihat mitra.
Bangun portal di sekitar APIKey, UsageLog, dan DeveloperDoc terlebih dahulu sehingga onboarding mitra memiliki kontrak backend yang jelas.
Manfaat Portal
Backend portal mitra yang menyimpan pekerjaan APIKey, tinjauan UsageLog, dan publikasi DeveloperDoc dalam satu tempat.
Onboarding mitra lebih cepat
Mulailah dengan kelas PartnerOrganization dan APIKey alih-alih menyusun tabel token dan aturan akses dari nol.
Tim dukungan mendapatkan konteks yang dapat digunakan
Baris UsageLog menunjukkan endpoint, metode, statusCode, requestCount, dan occurredAt saat mitra melaporkan permintaan yang gagal.
Penanganan kunci yang lebih aman
Simpan tokenPrefix dan scope alih-alih mengekspos rahasia mentah, dan putar isActive saat status kunci berubah.
Dokumen versi tetap terorganisir
DeveloperDoc memberikan catatan rilis, pemtargetan apiVersion, dan status publik yang memiliki struktur yang stabil.
Permukaan API tunggal untuk setiap klien
Portal web, alat admin seluler, dan dasbor internal dapat membaca data yang sama untuk User, PartnerOrganization, APIKey, UsageLog, dan DeveloperDoc.
Alur kerja bootstrap AI
Hasilkan skema, aturan akses, dan kerangka portal dengan cepat menggunakan satu prompt terstruktur.
Siap untuk meluncurkan portal mitra API Anda?
Biarkan Back4app AI Agent membangun backend portal mitra API Anda dan menghasilkan APIKey, UsageLog, dan alur DeveloperDoc dari satu prompt.
Gratis untuk memulai — 50 prompt AI Agent/bulan, tanpa kartu kredit yang diperlukan
Tumpukan Teknologi Portal
Semua yang termasuk dalam template backend portal mitra API ini.
Peta Hubungan Mitra
Model hubungan entitas untuk skema backend portal mitra API.
Skema yang mencakup pengguna, organisasi mitra, kunci API, log penggunaan, dan dokumen pengembang.
Lihat sumber diagram
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
}
Alur Integrasi Portal
Alur run-time khas untuk masuk, pencarian APIKey, tinjauan UsageLog, dan pembaruan DeveloperDoc.
Lihat sumber diagram
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
endKamus Bidang
Referensi tingkat bidang lengkap untuk setiap kelas dalam skema portal mitra API.
| Bidang | Tipe | Deskripsi | Diperlukan |
|---|---|---|---|
| objectId | String | Auto-generated unique identifier | Otomatis |
| username | String | Login name for a portal user | |
| String | Primary email address for portal access | ||
| password | String | Hashed password (write-only) | |
| role | String | Portal role such as admin, partnerAdmin, or developer | |
| createdAt | Date | Auto-generated creation timestamp | Otomatis |
| updatedAt | Date | Auto-generated last-update timestamp | Otomatis |
7 kolom di User
Kontrol Akses
Bagaimana strategi ACL dan CLP mengamankan mitra, catatan APIKey, entri UsageLog, dan halaman DeveloperDoc.
Akun yang terfokus pada mitra
Setiap catatan PartnerOrganization hanya dapat diedit oleh admin portal atau Pengguna primaryContact yang ditugaskan.
Kerahasiaan dan rotasi kunci
Simpan APIKey.tokenPrefix dan cakupan dalam tampilan publik, dan simpan bahan kunci mentah dari browser.
Batas bacaan log penggunaan
Batasi bacaan UsageLog ke partner yang memiliki APIKey dan ke peran dukungan yang membutuhkan akses pemecahan masalah.
Skema JSON
Definisi skema JSON mentah siap untuk disalin ke Back4app atau digunakan sebagai referensi implementasi.
{
"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
}
}
}
]
}Bangun dengan AI Agent
Gunakan Back4app AI Agent untuk menghasilkan aplikasi portal mitra API nyata dari template ini, termasuk frontend, backend, otentikasi, dan alur APIKey, UsageLog, dan DeveloperDoc.
Buat backend aplikasi portal mitra API di Back4app dengan skema dan perilaku yang persis ini. Skema: 1. User: username (String, wajib), email (String, wajib), password (String, wajib), role (String, wajib); objectId, createdAt, updatedAt (sistem). 2. PartnerOrganization: name (String, wajib), status (String, wajib), primaryContact (Pointer to User, wajib), supportTier (String, opsional); objectId, createdAt, updatedAt (sistem). 3. APIKey: keyName (String, wajib), tokenPrefix (String, wajib), scopes (Array<String>, wajib), isActive (Boolean, wajib), lastUsedAt (Date, opsional), partner (Pointer to PartnerOrganization, wajib), createdBy (Pointer to User, wajib); objectId, createdAt, updatedAt (sistem). 4. UsageLog: partner (Pointer to PartnerOrganization, wajib), apiKey (Pointer to APIKey, wajib), endpoint (String, wajib), method (String, wajib), statusCode (Number, wajib), requestCount (Number, wajib), occurredAt (Date, wajib); objectId, createdAt, updatedAt (sistem). 5. DeveloperDoc: title (String, wajib), slug (String, wajib), content (String, wajib), apiVersion (String, wajib), isPublished (Boolean, wajib), owner (Pointer to User, wajib), partner (Pointer to PartnerOrganization, opsional); objectId, createdAt, updatedAt (sistem). Keamanan: - Hanya admin portal atau pemilik yang ditugaskan yang dapat memperbarui data mitra. Hanya peran yang disetujui yang dapat membuat, merotasi, atau mencabut catatan APIKey. Batasi pembacaan UsageLog hanya kepada mitra yang memiliki dan peran dukungan. Autentikasi: - Daftar, masuk, keluar. Perilaku: - Daftar mitra, buat dan rotasi catatan APIKey, tinjau entri UsageLog, dan terbitkan halaman DeveloperDoc. Pengiriman: - Aplikasi Back4app dengan skema, ACL, CLP; frontend untuk akun mitra, manajemen kunci API, log penggunaan, dan dokumentasi pengembang.
Tekan tombol di bawah untuk membuka Agent dengan prompt template ini yang telah terisi sebelumnya.
Ini adalah prompt dasar tanpa akhiran teknologi. Anda dapat menyesuaikan tumpukan frontend yang dihasilkan setelahnya.
API Playground
Coba REST dan endpoint GraphQL terhadap skema portal mitra API. Respon menggunakan data tiruan dan tidak memerlukan akun Back4app.
Menggunakan skema yang sama dengan template ini.
Pilih Tumpukan Anda
Perluas setiap kartu untuk melihat cara mengintegrasikan PartnerOrganization, APIKey, dan UsageLog dengan tumpukan yang Anda pilih.
Flutter Portal Mitra API Backend
React Portal Mitra API Backend
React Native Portal Mitra API Backend
Next.js Portal Mitra API Backend
JavaScript Portal Mitra API Backend
Android Portal Mitra API Backend
iOS Portal Mitra API Backend
Vue Portal Mitra API Backend
Angular Portal Mitra API Backend
GraphQL Portal Mitra API Backend
REST API Portal Mitra API Backend
PHP Portal Mitra API Backend
.NET Portal Mitra API Backend
Apa yang Anda Dapatkan dengan Setiap Teknologi
Setiap tumpukan menggunakan skema backend portal mitra API dan kontrak API yang sama.
Struktur data portal yang terpadu
Kelola catatan Pengguna, PartnerOrganization, APIKey, UsageLog, dan DeveloperDoc dengan satu skema yang konsisten.
Kontrol siklus hidup kunci API
Terbitkan, putar, dan cabut catatan APIKey tanpa kehilangan jejak kepemilikan.
Visibilitas penggunaan untuk tim dukungan
Periksa entri UsageLog berdasarkan endpoint, metode, dan statusCode saat mitra membutuhkan bantuan.
Pelacakan rilis dokumentasi
Terbitkan pembaruan DeveloperDoc dengan catatan spesifik apiVersion untuk pengembang mitra.
REST/GraphQL APIs untuk klien portal
Melayani alat admin internal dan aplikasi yang dihadapi mitra melalui satu lapisan API.
Arsitektur yang dapat diperluas untuk alur kerja mitra
Tambahkan kelas seperti pengumuman atau langganan webhook tanpa menulis ulang inti portal.
Perbandingan Tumpukan Portal
Bandingkan kecepatan pengaturan, gaya SDK, dan dukungan AI di semua teknologi yang didukung.
| Kerangka kerja | Waktu Pengaturan | Manfaat Portal | Jenis SDK | Dukungan AI |
|---|---|---|---|---|
| Sekitar 5 menit | Basis kode tunggal untuk portal mitra di mobile dan web. | SDK Tertulis | Penuh | |
| Kurang dari 5 menit | Dasbor web cepat untuk kunci dan log mitra. | SDK Tipe | Penuh | |
| ~3–7 mnt | Aplikasi mobile lintas platform untuk dukungan mitra. | SDK Tipe | Penuh | |
| Pengaturan cepat (5 mnt) | Portal admin yang dirender di server untuk kunci dan dokumen. | SDK Tipe | Penuh | |
| ~3–5 mnt | Integrasi web yang ringan untuk operasional mitra. | SDK Tipe | Penuh | |
| Sekitar 5 menit | Aplikasi Android native untuk operasional mitra. | SDK Tipe | Penuh | |
| Di bawah 5 menit | Aplikasi iOS native untuk operasional mitra. | SDK Tipe | Penuh | |
| ~3–7 menit | Antarmuka web Reactive untuk tinjauan kunci dan dokumen. | SDK Tipe | Penuh | |
| Pengaturan cepat (5 menit) | Portal perusahaan untuk akses dan tinjauan penggunaan. | SDK Tertulis | Penuh | |
| Di bawah 2 menit | API GraphQL yang fleksibel untuk portal mitra. | API GraphQL | Penuh | |
| Pengaturan cepat (2 menit) | Integrasi REST API untuk portal mitra. | REST API | Penuh | |
| ~3 menit | Backend PHP sisi server untuk portal mitra. | REST API | Penuh | |
| ~3–7 menit | Backend .NET untuk portal mitra. | SDK Tipe | Penuh |
Waktu pengaturan mencerminkan durasi yang diharapkan dari pengembangan proyek hingga kueri pertama PartnerOrganization, APIKey, atau UsageLog menggunakan skema templat ini.
Portal Pertanyaan
Pertanyaan umum tentang membangun backend portal mitra API dengan template ini.
Siap untuk Membangun Aplikasi Portal Mitra API Anda?
Mulai proyek portal mitra Anda dalam hitungan menit. Tidak diperlukan kartu kredit.