API-Partnerportal-Back-End-Vorlage
Partnerzugang, API-Verkehr und Dokumentation
Ein produktionsbereites API-Partnerportal-Backend auf Back4app mit Benutzer, Partnerorganisation, API-Schlüssel, Nutzungsprotokoll und Entwicklervorlage. Enthält ER-Diagramm, Datendictionary, JSON-Schema, API-Spielplatz und eine AI-Agent Eingabeaufforderung für eine schnelle Einrichtung.
Portal Erkenntnisse
Diese Vorlage bietet Ihnen ein Backend für ein API-Partnerportal mit APIKey-Verwaltung, Überprüfung des UsageLogs und Veröffentlichung von DeveloperDocs, damit interne Teams und externe Partner eine gemeinsame Arbeitsfläche nutzen können.
- APIKey Lebenszykluskontrolle — Modellieren Sie APIKey-Datensätze mit Partnerbesitz, tokenPrefix, scopes, isActive und lastUsedAt-Feldern.
- Sichtbarkeit des UsageLogs — Verfolgen Sie UsageLog-Einträge pro apiKey, damit Sie die Endpunktaufrufe, StatusCode-Spitzen und Gesamtsummen der Anfrageanzahl überprüfen können.
- Aktualisierungen von DeveloperDocs — Halten Sie die DeveloperDoc-Datensätze mit den veröffentlichten API-Richtlinien in Einklang, indem Sie Titel, Slug, Inhalt, apiVersion und isPublished verwenden.
- Partnerzugriffsgrenzen — Verwenden Sie ACLs und CLPs, um die Arbeitsbereiche von Partnerorganisationen, API-Schlüsselzeilen und Nutzungsprotokolle auf das richtige Konto einzuschränken.
- Plattformübergreifendes Portal-Backend — Bedienen Sie Web- und Mobile-Clients über eine REST- und GraphQL API für Benutzer, Partnerorganisation, API-Schlüssel, Nutzungsprotokoll und Entwicklerdokumentation.
Was ist die API Partnerportal-Vorlage?
Berechtigungen sind wichtig im API Partnerportal: Partner, Mitarbeiter und Kunden sollten genau das sehen, was ihre Rolle erfordert – nichts mehr, nichts weniger. Zuverlässigkeit ist ein Merkmal, kein Fußnote. Diese Vorlage modelliert Partnerorganisation, API-Schlüssel, Nutzungsprotokoll und Entwicklerdokumentation mit rollenbasiertem Zugriff auf Back4app, sodass jedes Teammitglied des API Partnerportals die Schnitte des Pipelines sieht, die es besitzt. Das Schema deckt Benutzer (Benutzername, E-Mail, Passwort, Rolle), Partnerorganisation (Name, Status, Hauptkontakt, Unterstützungsebene), API-Schlüssel (Schlüsselname, Tokenpräfix, Scopes, aktiv, zuletzt verwendet am, Partner, erstellt von), Nutzungsprotokoll (Partner, API-Schlüssel, Endpunkt, Methode, Statuscode, Anforderungsanzahl, aufgetreten am) und Entwicklerdokumentation (Titel, Slug, Inhalt, API-Version, veröffentlicht, Eigentümer, Partner) mit Authentifizierung, Sichtbarkeitsregeln und Unterstützung für Partnerworkflows ab. Verbinden Sie Ihr bevorzugtes Frontend und versenden Sie schneller.
Am besten für:
Übersicht über die API-Partnerportal-Vorlage
Die meisten Fehler im API-Partnerportal sind langweilig: ein fehlender Zeitstempel, eine doppelte Zeile oder eine Zahl, die gestern richtig und heute falsch war.
Das Schema hinter Partnerorganisation, API-Schlüssel und Nutzungsprotokoll wird über Hubs und Technologieseiten geteilt; der Wechsel von Frameworks sollte nicht bedeuten, dass Datensätze neu gestaltet werden müssen.
Portal-Kernfunktionen
Jede Technologiekarte in diesem Hub verwendet das gleiche Backend-Schema des Partnerportals mit Benutzer, Partnerorganisation, APIKey, Nutzungsprotokoll und Entwicklerdokument.
Partnerkontoverwaltung
PartnerOrganization speichert Name, Status, primärenKontakt und Support-Ebene in einem Datensatz.
API-Schlüssel-Lebenszyklusverfolgung
API-Key speichert keyName, tokenPrefix, scopes, isActive, lastUsedAt, partner und createdBy.
Nutzungsprotokoll Überprüfung
Nutzungsprotokoll erfasst Partner, apiKey, Endpunkt, Methode, statusCode, anzahlAnfragen und occurredAt.
Entwicklerdokument veröffentlichen
Entwicklerdokument speichert Titel, slug, Inhalt, apiVersion, istVeröffentlicht, Eigentümer und Partner.
Warum Ihr API-Partnerportal-Backend mit Back4app erstellen?
Back4app bietet Ihnen User, PartnerOrganization, APIKey, UsageLog und DeveloperDoc-Primitiven, damit Ihr Team sich auf das Portal-Erlebnis und nicht auf die Backend-Integration konzentrieren kann.
- •Token- und Partnermanagement: APIKey ist direkt mit PartnerOrganization verbunden, was die Ausgabe, Rotation und Deaktivierung einfacher auditierbar macht.
- •Nutzungsübersicht, die echte Fragen beantwortet: UsageLog protokolliert Endpoint, Methode, StatusCode und RequestCount, sodass der Support ein Integrationsproblem ohne Rätselraten nachverfolgen kann.
- •Dokumentenaktualisierungen ohne Publishing-Flaschenhals: DeveloperDoc bietet Ihnen einen strukturierten Ort für Endpoint-Notizen, versionierte Anleitungen und partnerorientierte Änderungsverläufe.
Bauen Sie das Portal zuerst um APIKey, UsageLog und DeveloperDoc, damit das Onboarding der Partner einen klaren Backend-Vertrag hat.
Portal Vorteile
Ein Backend des Partnerportals, das die APIKey-Arbeit, die Überprüfung des Nutzungsprotokolls und die Veröffentlichung von Entwicklermaterial an einem Ort vereint.
Schnellere Partner-Onboarding
Beginnen Sie mit den Klassen PartnerOrganization und APIKey, anstatt Token-Tabellen und Zugriffsregeln von Grund auf neu zusammenzustellen.
Support-Teams erhalten nutzbaren Kontext
UsageLog-Reihen zeigen Endpoint, Methode, statusCode, requestCount und occurredAt an, wenn ein Partner einen fehlgeschlagenen Antrag meldet.
Sicherer Schlüsselumgang
Speichern Sie tokenPrefix und Scopes, anstatt rohe Geheimnisse offenzulegen, und drehen Sie isActive, wenn ein Schlüssel seinen Zustand ändert.
Versionierte Dokumente bleiben organisiert
DeveloperDoc bietet Versionshinweise, apiVersion-Zielvorgaben und den Veröffentlichungsstatus in einer stabilen Struktur.
Einzelne API-Oberfläche für jeden Client
Webportale, mobile Admin-Tools und interne Dashboards können dieselben Daten für User, PartnerOrganization, APIKey, UsageLog und DeveloperDoc lesen.
AI-Bootstrap-Workflow
Generieren Sie Schema, Zugriffsregeln und Portal-Gerüst schnell mit einem strukturierten Prompt.
Bereit, Ihr API-Partnerportal zu starten?
Lassen Sie den Back4app AI-Agenten Ihr API-Partnerportal-Backend erstellen und die APIKey-, UsageLog- und DeveloperDoc-Flows aus einem Prompt generieren.
Kostenlos starten – 50 AI-Agenten-Prompts pro Monat, keine Kreditkarte erforderlich
Portal-Technologie-Stack
Alles ist in dieser API-Partnerportal-Backend-Vorlage enthalten.
Partnerbeziehungsdiagramm
Entity-Relationship-Modell für das API-Partnerportal-Backend-Schema.
Schema für Benutzer, Partnerorganisationen, API-Schlüssel, Nutzungsprotokolle und Entwicklerdokumentationen.
Diagrammquelle anzeigen
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-Integrationsfluss
Typischer Ablauf zur Laufzeit für die Anmeldung, APIKey-Abfrage, Überprüfung des Nutzungsprotokolls und Aktualisierungen der Entwicklerdokumentation.
Diagrammquelle anzeigen
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
endFeld Wörterbuch
Vollständige Referenz auf Feldebene für jede Klasse im Schema des API-Partnerportals.
| Feld | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
| objectId | String | Auto-generated unique identifier | Automatisch |
| 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 | Automatisch |
| updatedAt | Date | Auto-generated last-update timestamp | Automatisch |
7 Felder in User
Zugriffskontrollen
Wie die ACL- und CLP-Strategie Partner, APIKey-Datensätze, UsageLog-Einträge und DeveloperDoc-Seiten sichert.
Partner-spezifische Konten
Jeder PartnerOrganization-Datensatz sollte nur von Portal-Admins oder dem zugewiesenen primären Kontaktbenutzer bearbeitet werden können.
Schlüsselgeheimnis und Rotation
Speichern Sie APIKey.tokenPrefix und Scopes in öffentlichen Ansichten und halten Sie Rohschlüsselmaterial aus dem Browser fern.
Nutzungsprotokoll Lesegrenzen
Begrenzen Sie die Nutzungsprotokoll-Lesungen auf den Partner, der den API-Schlüssel besitzt, und auf Support-Rollen, die Zugriff zur Fehlersuche benötigen.
JSON-Schema
Roh-JSON-Schemadefinition bereit zum Kopieren in Back4app oder zur Verwendung als Implementierungsreferenz.
{
"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
}
}
}
]
}Mit KI-Agenten erstellen
Verwenden Sie den Back4app KI-Agenten, um eine echte API-Partnerportal-App aus dieser Vorlage zu erstellen, einschließlich Frontend, Backend, Authentifizierung sowie API-Schlüssel-, Nutzungsprotokoll- und Entwicklerdokumentationsabläufen.
Erstellen Sie ein Backend für die API-Partnerportal-App auf Back4app mit diesem exakten Schema und Verhalten. Schema: 1. Benutzer: Benutzername (String, erforderlich), E-Mail (String, erforderlich), Passwort (String, erforderlich), Rolle (String, erforderlich); objectId, createdAt, updatedAt (System). 2. PartnerOrganisation: Name (String, erforderlich), Status (String, erforderlich), primärerKontakt (Zeiger auf Benutzer, erforderlich), supportStufe (String, optional); objectId, createdAt, updatedAt (System). 3. APIKey: keyName (String, erforderlich), tokenPrefix (String, erforderlich), scopes (Array<String>, erforderlich), isActive (Boolean, erforderlich), lastUsedAt (Datum, optional), partner (Zeiger auf PartnerOrganisation, erforderlich), createdBy (Zeiger auf Benutzer, erforderlich); objectId, createdAt, updatedAt (System). 4. UsageLog: partner (Zeiger auf PartnerOrganisation, erforderlich), apiKey (Zeiger auf APIKey, erforderlich), endpoint (String, erforderlich), method (String, erforderlich), statusCode (Nummer, erforderlich), requestCount (Nummer, erforderlich), occurredAt (Datum, erforderlich); objectId, createdAt, updatedAt (System). 5. EntwicklerDokumentation: Titel (String, erforderlich), slug (String, erforderlich), Inhalt (String, erforderlich), apiVersion (String, erforderlich), isPublished (Boolean, erforderlich), owner (Zeiger auf Benutzer, erforderlich), partner (Zeiger auf PartnerOrganisation, optional); objectId, createdAt, updatedAt (System). Sicherheit: - Nur Portaladministratoren oder zugewiesene Eigentümer können Partnerdaten aktualisieren. Nur genehmigte Rollen können APIKey-Datensätze erstellen, rotieren oder widerrufen. Zugriff auf UsageLog-Daten einschränken auf den besitzenden Partner und Support-Rollen. Auth: - Registrierung, Anmeldung, Abmeldung. Verhalten: - Partner auflisten, APIKey-Datensätze erstellen und rotieren, UsageLog-Einträge überprüfen und EntwicklerDokumentationsseiten veröffentlichen. Liefern: - Back4app-App mit Schema, ACLs, CLPs; Frontend für Partnerkonten, API-Schlüsselverwaltung, Nutzungsprotokolle und Entwicklerdokumentation.
Drücken Sie die Schaltfläche unten, um den Agenten mit dieser Vorlage und vorausgefüllter Eingabeaufforderung zu öffnen.
Dies ist der Basis-Prompt ohne einen Technologiesuffix. Sie können den generierten Frontend-Stack anschließend anpassen.
API Playground
Testen Sie REST- und GraphQL-Endpoints gegen das Schema des API-Partnerportals. Antworten verwenden Mock-Daten und erfordern kein Back4app-Konto.
Verwendet dasselbe Schema wie diese Vorlage.
Wählen Sie Ihren Stack
Erweitern Sie jede Karte, um zu sehen, wie Sie PartnerOrganization, APIKey und UsageLog mit Ihrem gewählten Stack integrieren können.
Flutter API-Partnerportal-Backend
React API-Partnerportal-Backend
React Native API-Partnerportal-Backend
Next.js API-Partnerportal-Backend
JavaScript API-Partnerportal-Backend
Android API-Partnerportal-Backend
iOS API-Partnerportal-Backend
Vue API-Partnerportal-Backend
Angular API-Partnerportal-Backend
GraphQL API-Partnerportal-Backend
REST API API-Partnerportal-Backend
PHP API-Partnerportal-Backend
.NET API-Partnerportal-Backend
Was Sie mit jeder Technologie erhalten
Jeder Stack verwendet dasselbe API-Partnerportal-Backend-Schema und API-Verträge.
Vereinte Portal-Datenstruktur
Verwalten Sie Benutzer, PartnerOrganization, APIKey, UsageLog und DeveloperDoc-Datensätze mit einem konsistenten Schema.
API-Schlüssel-Lifecycle-Kontrollen
Ausstellen, Drehen und Widerrufen von APIKey-Datensätzen, ohne den Eigentumspfad zu verlieren.
Nutzungsübersicht für Support-Teams
Überprüfen Sie UsageLog-Einträge nach Endpunkt, Methode und Statuscode, wenn Partner Hilfe benötigen.
Dokumentationsfreigabeverfolgung
Veröffentlichen Sie Aktualisierungen der DeveloperDoc mit apiVersion-spezifischen Notizen für Partnerentwickler.
REST/GraphQL APIs für Portal-Clients
Bieten Sie interne Admin-Tools und partnerorientierte Apps über eine API-Schicht an.
Erweiterbare Architektur für Partner-Workflows
Fügen Sie Klassen wie Ankündigungen oder Webhook-Abonnements hinzu, ohne den Kern des Portals neu zu schreiben.
Portal-Stack-Vergleich
Vergleichen Sie die Einrichtungsgeschwindigkeit, den SDK-Stil und die KI-Unterstützung aller unterstützten Technologien.
| Framework | Einrichtungszeit | Portalvorteil | SDK-Typ | KI-Unterstützung |
|---|---|---|---|---|
| Ungefähr 5 Minuten | Einzelner Codebestand für das Partnerportal auf Mobilgeräten und im Web. | Typed SDK | Vollständig | |
| Unter 5 Minuten | Schnelles Web-Dashboard für Partner-Keys und Protokolle. | Getippte SDK | Vollständig | |
| ~3–7 min | Plattformübergreifende mobile App für Partnersupport. | Getippte SDK | Vollständig | |
| Schnelle (5 min) Einrichtung | Servergerendertes Admin-Portal für Keys und Dokumente. | Getippte SDK | Vollständig | |
| ~3–5 min | Leistungsstarke Webintegration für Partneroperationen. | Getippte SDK | Vollständig | |
| Ungefähr 5 Minuten | Native Android-App für Partneroperationen. | Typisierte SDK | Vollständig | |
| Unter 5 Minuten | Native iOS-App für Partneroperationen. | Typisierte SDK | Vollständig | |
| ~3–7 Minuten | Reactive Web-Benutzeroberfläche für wichtige Überprüfungen und Dokumente. | Typisierte SDK | Vollständig | |
| Schnelle (5 Min) Einrichtung | Enterprise-Portal für Zugriffs- und Nutzungsprüfung. | Typed SDK | Vollständig | |
| Unter 2 Min | Flexibles GraphQL API für das Partnerportal. | GraphQL API | Vollständig | |
| Schnelle (2 Min) Einrichtung | REST API Integration für das Partnerportal. | REST API | Vollständig | |
| ~3 Min | Server-seitiges PHP Backend für das Partnerportal. | REST API | Vollständig | |
| ~3–7 Minuten | .NET Backend für das Partnerportal. | Typisierte SDK | Vollständig |
Die Einrichtungszeit spiegelt die erwartete Dauer vom Projektstart bis zur ersten PartnerOrganisation, APIKey oder UsageLog-Abfrage unter Verwendung dieses Vorlagenschemas wider.
Portal Fragen
Allgemeine Fragen zum Erstellen eines API-Partnerportals mit diesem Template.
Bereit, deine API-Partnerportal-App zu erstellen?
Starte dein Partnerportal-Projekt in wenigen Minuten. Keine Kreditkarte erforderlich.