Бэкэнд портала партнеров API

Шаблон бэкэнда портала партнеров API
Доступ для партнеров, трафик API и документация

Q: Как выглядит здоровый пайплайн портала партнеров API, когда работа чувствительна и зависит от сроков?

Бэкэнд портала партнеров API — это схема и API для партнерских аккаунтов, управления API-ключами, журналов использования и документации для разработчиков в одном общем рабочем пространстве.

Q: Какие рабочие процессы портала партнеров API больше всего выигрывают от структурированных задач по сравнению со свободными заметками?

Он включает в себя User (имя пользователя, электронная почта, пароль, роль), PartnerOrganization (название, статус, основной контакт, уровень поддержки), APIKey (имя ключа, префикс токена, области, активен, последний раз использован, партнер, создано), UsageLog (партнер, apiKey, конечная точка, метод, код статуса, количество запросов, произошедшее), и DeveloperDoc (заголовок, slug, содержимое, версия API, опубликовано, владелец, партнер), плюс диаграмму ER, API playground и подсказку AI Agent.

Q: Достаточно ли модель доступа детализирована для партнеров и подрядчиков портала API?

Back4app предоставляет управляемую базу данных, аутентификацию, запросы в реальном времени и гибкую схему, чтобы вы могли разрабатывать партнерские аккаунты, обработку APIKey, отслеживание UsageLog и публикацию документации без необходимости запуска собственного бэкенда.

Q: Как мне выполнять запросы для ключей и журналов с Flutter?

Используйте классы APIKey и UsageLog для запроса записей партнеров, сортировки по времени произошедшего и отображения состояния ключа и активности использования в портале.

Q: Как мне управлять доступом к порталу партнеров API с Next.js Server Actions?

Используйте серверное действие для создания объекта Parse для APIKey с указателем на PartnerOrganization и полями статуса, затем проверьте доступ в Cloud Code перед сохранением.

Q: Может ли React хранить журналы использования кэша в автономном режиме?

Да. Включите локальное хранилище данных и зафиксируйте результаты UsageLog и APIKey, чтобы администраторы могли проверять недавние запросы и состояние ключа без подключения к сети.

Q: Как мне предотвратить несанкционированный доступ к ключу?

В Cloud Code beforeSave для APIKey требуйте, чтобы вызывающий имел одобренную роль, и отклоняйте запросы, которые пытаются изменить tokenPrefix, scopes, isActive или lastUsedAt без разрешения.

Q: Какой лучший способ показать использование партнера на Android?

Запросите UsageLog по партнеру и apiKey, затем отобразите endpoint, метод, статусный код и количество запросов с использованием пагинации SDK Back4app и локального кэша, где это необходимо.

Q: Как работает поток ротации API ключа от начала до конца?

Администратор создает или ротирует APIKey для PartnerOrganization, портал сохраняет новый tokenPrefix, scopes и состояние isActive, UsageLog начинает записывать запросы под этим ключом, и команда документации публикует соответствующее обновление DeveloperDoc для партнерских разработчиков.

Готовый к производству бэкэнд портала партнеров API на Back4app с Пользователем, PartnerOrganization, API-ключом, журналом использования и документацией для разработчиков. Включает диаграмму ER, словарь данных, схему JSON, зону для работы с API и команду AI Agent для быстрой настройки.

Создать с AI-агентом Выберите вашу технологию

Итоги портала

Этот шаблон предоставляет вам бэкенд партнерского портала API с управлением APIKey, проверкой UsageLog и публикацией DeveloperDoc, чтобы внутренние команды и внешние партнеры имели одну рабочую поверхность.

Контроль жизненного цикла APIKey — Моделируйте записи APIKey с полями партнерской собственности, tokenPrefix, scopes, isActive и lastUsedAt.
Видимость UsageLog — Отслеживайте записи UsageLog по apiKey, чтобы вы могли просматривать вызовы конечной точки, скачки statusCode и общие значения requestCount.
Обновления DeveloperDoc — Держите записи DeveloperDoc в соответствии с опубликованными руководствами по API, используя title, slug, content, apiVersion и isPublished.
Границы доступа партнеров — Используйте ACL и CLP, чтобы ограничить рабочие пространства PartnerOrganization, строки APIKey и записи UsageLog для соответствующего аккаунта.
Кроссплатформенный портал бэкенда — Обслуживайте веб и мобильных клиентов через один REST и GraphQL API для User, PartnerOrganization, APIKey, UsageLog и DeveloperDoc.

Что такое шаблон API Partner Portal?

Права доступа важны в API партнерском портале: партнеры, сотрудники и клиенты должны видеть именно то, что требуется их роли — ни больше, ни меньше. Надежность — это функция, а не сноска. Этот шаблон моделирует PartnerOrganization, APIKey, UsageLog и DeveloperDoc с ролевым доступом на Back4app, так что каждый участник API партнерского портала видит ту часть пайплайна, за которую он отвечает. Схема охватывает User (имя пользователя, электронная почта, пароль, роль), PartnerOrganization (имя, статус, основной контакт, уровень поддержки), APIKey (keyName, tokenPrefix, scopes, isActive, lastUsedAt, partner, createdBy), UsageLog (partner, apiKey, endpoint, method, statusCode, requestCount, occurredAt) и DeveloperDoc (заголовок, slug, содержание, apiVersion, isPublished, владелец, партнер) с встроенной аутентификацией, правилами видимости и поддержкой рабочего процесса партнеров. Подключите ваш предпочитаемый фронтенд и ускорьте доставку.

Лучшее для:

API партнерские порталыДашборды жизненного цикла APIKeyКонсоли аналитики UsageLogЦентры публикации DeveloperDocB2B интеграцииКоманды выбирают BaaS для общего доступа к API

Обзор шаблона портала API-партнера

Большинство ошибок портала API-партнера обыденны: пропущенная метка времени, дублированная строка или количество, которое было правильным вчера и неправильным сегодня.

Схема за PartnerOrganization, APIKey и UsageLog общая для центров и технологических страниц; смена фреймворков не должна означать переработку записей.

Основные функции портала

Каждая карточка технологии в этом центре использует одну и ту же схему бэкенда партнерского портала с User, PartnerOrganization, APIKey, UsageLog и DeveloperDoc.

Управление учётной записью партнёра

PartnerOrganization хранит имя, статус, первичный контакт и уровень поддержки в одной записи.

Отслеживание жизненного цикла APIKey

APIKey хранит имя ключа, префикс токена, области действия, активен или нет, последний раз использован, партнёр и создано кем.

Обзор UsageLog

UsageLog фиксирует партнера, apiKey, endpoint, метод, статус-код, количество запросов и дату возникновения.

Публикация DeveloperDoc

DeveloperDoc хранит заголовок, slug, контент, apiVersion, isPublished, владельца и партнера.

Почему стоит создать бэкенд вашего API Partner Portal с помощью Back4app?

Back4app предоставляет вам примитивы User, PartnerOrganization, APIKey, UsageLog и DeveloperDoc, чтобы ваша команда могла сосредоточиться на портальном опыте, а не на бэкенд-работах.

•Управление токенами и партнерами: APIKey напрямую связан с PartnerOrganization, что упрощает аудит выпуска, ротации и деактивации.
•Видимость использования, отвечающая на реальные вопросы: UsageLog записывает конечную точку, метод, statusCode и requestCount, чтобы служба поддержки могла отслеживать проблему интеграции без догадок.
•Обновления документации без узких мест в публикации: DeveloperDoc предоставляет структурированное место для заметок по конечным точкам, версионных руководств и истории изменений, доступной для партнеров.

Сначала создайте портал вокруг APIKey, UsageLog и DeveloperDoc, чтобы интеграция партнеров имела четкий контракт в бэкенде.

Преимущества портала

Партнерский портал бэкенда, который хранит работу с APIKey, обзор UsageLog и публикацию DeveloperDoc в одном месте.

Быстрое подключение партнеров

Начните с классов PartnerOrganization и APIKey вместо того, чтобы собирать таблицы токенов и правила доступа с нуля.

Команды поддержки получают полезный контекст

Строки UsageLog показывают конечную точку, метод, код статуса, количество запросов и время возникновения, когда партнер сообщает о неудачном запросе.

Более безопасное управление ключами

Храните tokenPrefix и области вместо того, чтобы раскрывать сырые секреты, и изменяйте isActive, когда состояние ключа меняется.

Версионированные документы остаются организованными

DeveloperDoc предоставляет стабильную структуру для примечаний к релизу, таргетирования apiVersion и состояния публикации.

Единый API для каждого клиента

Веб-порталы, мобильные административные инструменты и внутренние информационные панели могут читать одни и те же данные User, PartnerOrganization, APIKey, UsageLog и DeveloperDoc.

AI рабочий процесс загрузки

Быстро генерируйте схему, правила доступа и каркас портала с помощью одного структурированного запроса.

Готовы запустить ваш портал партнеров API?

Позвольте AI-агенту Back4app создать бэкенд вашего портала партнеров API и сгенерировать APIKey, UsageLog и потоки DeveloperDoc из одного запроса.

Создавайте с помощью AI-агента Попробуйте API Playground

Бесплатно для начала — 50 запросов AI-агента в месяц, кредитная карта не требуется

Технологический стек портала

Все включено в этот шаблон backend портала партнеров API.

Фронтенд

13+ технологий

Бэкенд

Back4app

База данных

MongoDB

Аутентификация

Встроенная аутентификация + сессии

API

REST и GraphQL

Реальное время

Live Queries

Карта отношений с партнерами

Модель взаимосвязей сущностей для схемы бэкэнда портала партнеров API.

ER Диаграмма

Просмотреть источник диаграммы

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
    }

Поток интеграции портала

Типичный поток выполнения для входа, поиска APIKey, просмотра UsageLog и обновления DeveloperDoc.

ER Диаграмма

Просмотреть источник диаграммы

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

Словарь полей

Полная справка на уровне полей для каждого класса в схеме API партнёрского портала.

Поле	Тип	Описание	Обязательно
objectId	String	Auto-generated unique identifier	Авто
username	String	Login name for a portal user
email	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	Авто
updatedAt	Date	Auto-generated last-update timestamp	Авто

7 поля в User

Контроль доступа

Как стратегия ACL и CLP обеспечивает безопасность партнеров, записей APIKey, записей UsageLog и страниц DeveloperDoc.

Учетные записи, ограниченные партнером

Каждая запись PartnerOrganization должна редактироваться только администраторами портала или назначенным пользователем primaryContact.

Секретность ключа и ротация

Храните APIKey.tokenPrefix и области в общих представлениях, а сырые ключевые материалы держите вне браузера.

Границы чтения журнала использования

Ограничить чтение UsageLog партнером, владельцем APIKey, и ролями поддержки, которые нуждаются в доступе к устранению неполадок.

JSON-схема

Сырая определение JSON-схемы готова для копирования в Back4app или использования в качестве справочного материала для реализации.

JSON

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

{
  "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
        }
      }
    }
  ]
}

Создание с помощью AI Agent

Используйте AI Agent Back4app для генерации реального приложения партнерского портала API из этого шаблона, включая фронтенд, бэкенд, аутентификацию и потоки APIKey, UsageLog и DeveloperDoc.

AI Agent Back4app

Готовы к созданию

Создайте бэкенд приложения партнерского портала API на Back4app с этой точной схемой и поведением.

Схема:
1. Пользователь: имя пользователя (Строка, обязательно), электронная почта (Строка, обязательно), пароль (Строка, обязательно), роль (Строка, обязательно); objectId, createdAt, updatedAt (система).
2. ПартнерскаяОрганизация: название (Строка, обязательно), статус (Строка, обязательно), основнойКонтакт (Указатель на Пользователя, обязательно), уровеньПоддержки (Строка, необязательно); objectId, createdAt, updatedAt (система).
3. APIКлюч: имяКлюча (Строка, обязательно), префиксТокена (Строка, обязательно), области (Массив<Строка>, обязательно), активен (Булевый, обязательно), последнийИспользован (Дата, необязательно), партнер (Указатель на ПартнерскуюОрганизацию, обязательно), создано (Указатель на Пользователя, обязательно); objectId, createdAt, updatedAt (система).
4. ЖурналИспользования: партнер (Указатель на ПартнерскуюОрганизацию, обязательно), apiKey (Указатель на APIКлюч, обязательно), конечнаяТочка (Строка, обязательно), метод (Строка, обязательно), кодСтатуса (Число, обязательно), количествоЗапросов (Число, обязательно), произошло (Дата, обязательно); objectId, createdAt, updatedAt (система).
5. ДокументацияРазработчика: название (Строка, обязательно), slug (Строка, обязательно), содержание (Строка, обязательно), версияAPI (Строка, обязательно), опубликовано (Булевый, обязательно), владелец (Указатель на Пользователя, обязательно), партнер (Указатель на ПартнерскуюОрганизацию, необязательно); objectId, createdAt, updatedAt (система).

Безопасность:
- Только администраторы портала или назначенные владельцы могут обновлять данные партнеров. Только утвержденные роли могут создавать, менять или аннулировать записи APIКлючей. Ограничить чтение ЖурналаИспользования только для владельца партнера и ролей поддержки.

Аутентификация:
- Регистрация, вход, выход.

Поведение:
- Список партнеров, создание и ротация записей APIКлючей, просмотр записей ЖурналаИспользования и публикация страниц ДокументацииРазработчика.

Доставка:
- Приложение Back4app с схемой, ACL, CLP; фронтенд для аккаунтов партнеров, управление API ключами, журналы использования и документация для разработчиков.

Нажмите кнопку ниже, чтобы открыть Агент с заранее заполненным шаблоном запроса.

Это базовый запрос без суффикса технологии. Вы можете адаптировать сгенерированный стек фронтенда позже.

Развернуть за несколько минут50 бесплатных запросов / месяцКредитная карта не требуется

API Игровая площадка

Попробуйте REST и конечные точки GraphQL против схемы партнерского портала API. Ответы используют тестовые данные и не требуют учетной записи Back4app.

Загрузка песочницы…

Использует ту же схему, что и этот шаблон.

Выберите ваш стек

Раскройте каждую карточку, чтобы увидеть, как интегрировать PartnerOrganization, APIKey и UsageLog с вашим выбранным стеком.

Что вы получаете с каждой технологией

Каждый стек использует одну и ту же схему бэкенда портала API и контрактов API.

Унифицированная структура данных портала

Управляйте записями User, PartnerOrganization, APIKey, UsageLog и DeveloperDoc с помощью одной согласованной схемы.

Контроль жизненного цикла ключа API

Выдавайте, вращайте и отзывайте записи APIKey, не теряя следа владения.

Видимость использования для команд поддержки

Проверяйте записи UsageLog по конечной точке, методу и statusCode, когда партнёрам нужна помощь.

Отслеживание выпуска документации

Публикуйте обновления DeveloperDoc с заметками, специфичными для apiVersion, для партнёрских разработчиков.

REST/GraphQL API для клиентов портала

Обслуживайте внутренние администраторские инструменты и приложения для партнёров через один слой API.

Расширяемая архитектура для рабочих процессов партнёров

Добавляйте классы, такие как объявления или подписки на вебхуки, не переписывая ядро портала.

Сравнение стека портала

Сравните скорость настройки, стиль SDK и поддержку ИИ среди всех поддерживаемых технологий.

Фреймворк	Время настройки	Преимущество портала	Тип SDK	Поддержка ИИ
Flutter	Около 5 минут	Единая кодовая база для партнерского портала на мобильных и веб.	Типизированный SDK	Полный
React	Менее 5 минут	Быстрая веб-панель для ключей партнёров и журналов.	Типизированный SDK	Полный
React Native	~3–7 мин	Кросс-платформенное мобильное приложение для поддержки партнёров.	Типизированный SDK	Полный
Next.js	Быстрая настройка (5 мин)	Серверный административный портал для ключей и документов.	Типизированный SDK	Полный
JavaScript	~3–5 мин	Легкая веб-интеграция для операций партнера.	Типизированный SDK	Полный
Android	Около 5 мин	Нативное приложение Android для операций партнера.	Набор SDK с строгой типизацией	Полный
iOS	Менее 5 минут	Нативное приложение iOS для операций партнера.	Набор SDK с строгой типизацией	Полный
Vue	~3–7 мин	Reactивый веб-интерфейс для ключевых обзоров и документов.	Набор SDK с строгой типизацией	Полный
Angular	Быстрая установка (5 мин)	Корпоративный портал для доступа и обзора использования.	Написанный SDK	Полный
GraphQL	Менее 2 мин	Гибкий GraphQL API для партнерского портала.	GraphQL API	Полный
REST API	Быстрая установка (2 мин)	Интеграция REST API для партнерского портала.	REST API	Полный
PHP	~3 мин	Серверный PHP бэкенд для партнерского портала.	REST API	Полный
.NET	~3–7 мин	Бэкенд .NET для партнерского портала.	Типизированный SDK	Полный

Время настройки отражает ожидаемую продолжительность от развертывания проекта до первого запроса PartnerOrganization, APIKey или UsageLog с использованием этой схемы шаблона.

Вопросы портала

Общие вопросы о создании бэкенда партнерского API портала с помощью этого шаблона.

Как выглядит здоровый пайплайн портала партнеров API, когда работа чувствительна и зависит от сроков?

Какие рабочие процессы портала партнеров API больше всего выигрывают от структурированных задач по сравнению со свободными заметками?

Достаточно ли модель доступа детализирована для партнеров и подрядчиков портала API?

Как мне выполнять запросы для ключей и журналов с Flutter?

Как мне управлять доступом к порталу партнеров API с Next.js Server Actions?

Может ли React хранить журналы использования кэша в автономном режиме?

Как мне предотвратить несанкционированный доступ к ключу?

Какой лучший способ показать использование партнера на Android?

Как работает поток ротации API ключа от начала до конца?

Доверяют разработчики по всему миру

Присоединяйтесь к командам, быстро выпускающим продукты API для партнерских порталов с помощью шаблонов Back4app

Готовы создать свое приложение для API партнерского портала?

Начните свой проект партнерского портала за несколько минут. Кредитная карта не требуется.

Выберите технологию

Шаблон бэкэнда портала партнеров APIДоступ для партнеров, трафик API и документация