API Gateway v2.4 · Все сервисы онлайн (99.98% SLA)

Платформа и сервисы для разработчиков

Проектируйте интерактивные WebApp-приложения, подключайте ботов и автоматизации, интегрируйте внешние микросервисы через событийно-ориентированный REST API и безопасный шлюз авторизации OAuth 2.0.

0
Моих WebApp
0
Моих ботов
0
API Ключей
14мс
Latency шлюза

Архитектурные возможности платформы Sociq

Расширяемый стек инструментов для встраиваемых приложений, ботов и интеграции внешних сервисов.

WebApp (Mini-Apps)

Полнофункциональные HTML5/React/Vue приложения внутри соцсети. Безопасная песочница, нативный мост JavaScript SDK, автоматическая передача данных авторизации и темы оформления.

Боты & Автоматизация

Интеллектуальные боты для личных диалогов, каналов и комментариев. Мгновенные Webhook-события с криптографической проверкой подлинности HMAC-SHA256.

Шлюз API & Микросервисы

OAuth 2.0 Client Credentials Grant, разграничение прав (Scopes RBAC), Rate Limiting (5,000 req/min), гарантированная доставка событий через Outbox Queue и сквозной аудит.

Быстрый старт за 3 шага

От идеи до работающей интеграции в каталоге за 5 минут

1
Выпустите API-ключ

В разделе «API Ключи» создайте учетную запись, выберите нужные права (Scopes) и сохраните Client ID и Client Secret.

2
Подключите SDK или Webhook

Для WebApp подключите библиотеку window.SociqApp. Для ботов настройте обработчик POST-запросов с валидацией подписи.

Примеры кода
3
Публикация в каталоге

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

Мои WebApp-приложения

Управление интерактивными приложениями, играми и витринами в соцсети

Требуется авторизация

Войдите или зарегистрируйтесь в социальной сети, чтобы создавать и публиковать свои WebApp-приложения.

Войти в аккаунт

Мои Боты и Автоматизации

Управление чат-ботами, Webhook URL и ротация секретных ключей доступа

Требуется авторизация

Войдите в аккаунт, чтобы создавать ботов, автоматизации и чат-ассистентов.

Войти в аккаунт

API Ключи и Учетные данные

Client ID и Client Secret для OAuth 2.0 Client Credentials Grant

Политика безопасности учётных данных

При выпуске нового ключа параметр client_secret отображается только один раз. Обязательно сохраните его в защищённом хранилище конфигураций вашего сервера. Никогда не передавайте Client Secret в клиентский код браузера или публичные репозитории!

Требуется авторизация

Войдите в аккаунт, чтобы выпускать API-ключи для интеграций с платформой.

Войти в аккаунт
Глава 1

Архитектура Микросервисной Платформы Sociq

Слабосвязанный стек компонентов, событийная модель (Event-Driven) и шлюз API

Frontend Client
WebApp / Bots / CRM

Интерфейс, JS SDK, Webhook слушатели

Core Gateway
Sociq API Gateway

Rate Limit · RBAC Scopes · Correlation ID

Async Outbox
Event Bus & Workers

Очереди задач, повторы, аудит операций

Стандарты подключения микросервисов:
  • Health Check Endpoint: каждый подключенный микросервис обязан реализовать эндпоинт доступности (например, GET /health или GET /ping), возвращающий HTTP 200 и JSON {"status":"ok","uptime":3600,"version":"1.0"}. Платформа непрерывно мониторит состояние и фиксирует время задержки (Latency).
  • Сквозная трассировка (Correlation-ID): платформа передаёт во всех запросах заголовок X-Correlation-ID, который необходимо сохранять в логах вашего сервиса для сквозного аудита инцидентов.
  • Гарантия доставки через Outbox: события между сервисами фиксируются в транзакционном реестре platform__events_outbox с гарантией доставки at-least-once и фоновым воркером cron.php.
Глава 2

Авторизация по протоколу OAuth 2.0

Получение Bearer-токена для вызова серверных методов REST API

Для выполнения запросов к API внешние бэкенды используют протокол Client Credentials Grant. Вы отправляете ваш client_id и client_secret, полученные в разделе «API Ключи», и получаете временный токен доступа (Bearer Token) со сроком жизни 24 часа (86 400 секунд).

POST /api/v1/platform?action=oauth_token
Публичный эндпоинт авторизации
Пример запроса на получение токена:
cURL
curl -X POST "https://my45.ru/api/v1/platform" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "action=oauth_token" \ -d "client_id=cli_your_client_id" \ -d "client_secret=sec_your_client_secret"
Пример успешного ответа (200 OK):
JSON
{ "status": "ok", "token_type": "Bearer", "access_token": "atk_7f8a9b0c1d2e3f4a5b6c7d8e...", "expires_in": 86400, "scope": "users.read_basic,posts.create,notifications.send" }
Глава 3

Разработка WebApp и библиотека JavaScript SDK

Встраивание интерактивных интерфейсов, игр и сервисов в соцсеть

WebApp загружается в изолированном <iframe> внутри контейнера социальной сети. Для безопасного взаимодействия с интерфейсом соцсети используется библиотека-мост SociqApp SDK.

HTML / JavaScript
<!-- Подключение официального JS SDK --> <script src="https://my45.ru/assets/appearance/standart/js/apps-bridge.js"></script> <script> // 1. Уведомить соцсеть о готовности интерфейса (скрывает индикатор загрузки) window.SociqApp.ready(); // 2. Развернуть приложение на полную высоту окна window.SociqApp.expand(); // 3. Получить данные авторизованного пользователя const user = window.SociqApp.initDataUnsafe.user; console.log('Пользователь:', user.id, user.first_name); // 4. Отправка полезной нагрузки родительскому окну соцсети function finishOrder(orderId) { window.SociqApp.sendData(JSON.stringify({ order_id: orderId, status: 'completed' })); } </script>
Справочник методов и свойств объекта window.SociqApp:
Метод / Свойство Тип Описание
SociqApp.ready() Method Уведомляет контейнер соцсети о завершении начальной отрисовки интерфейса. Скрывает загрузчик.
SociqApp.expand() Method Разворачивает фрейм приложения на максимально доступную высоту экрана.
SociqApp.close() Method Закрывает WebApp и плавно возвращает пользователя на предыдущую страницу соцсети.
SociqApp.sendData(payload) Method Отправляет строковую полезную нагрузку (JSON string) контейнеру соцсети для обработки.
SociqApp.showAlert(msg) Method Вызывает нативный диалог оповещения социальной сети.
SociqApp.openLink(url) Method Безопасно открывает внешнюю ссылку в отдельной вкладке браузера.
SociqApp.initData String Сырая строка параметров запуска, подписанная HMAC-SHA256, для отправки на ваш бэкенд.
SociqApp.initDataUnsafe Object Распарсенный объект параметров с ID, именем и аватаром пользователя для быстрой отрисовки.
Глава 4

Криптографическая проверка подписи initData

Аутентификация пользователя на вашем сервере без передачи паролей

Каждый запуск WebApp снабжается строкой initData. Чтобы злоумышленник не мог подделать user_id на клиенте, серверная часть вашего приложения обязана валидировать подпись hash по вашему Client Secret.

PHP 8.x
function validateSociqInitData(string $initData, string $secretKey): bool { parse_str($initData, $data); if (!isset($data['hash'])) return false; $hash = $data['hash']; unset($data['hash']); // Сортировка параметров по алфавиту ksort($data); $checkStrings = []; foreach ($data as $k => $v) { $checkStrings[] = $k . '=' . $v; } $dataCheckString = implode("\n", $checkStrings); // Вычисление HMAC-SHA256 подписи $secretKeyHash = hash_hmac('sha256', $secretKey, 'WebAppData', true); $calculatedHash = hash_hmac('sha256', $dataCheckString, $secretKeyHash); return hash_equals($calculatedHash, $hash); }
Node.js / Express
import crypto from 'crypto'; export function validateSociqInitData(initDataString: string, secretKey: string): boolean { const params = new URLSearchParams(initDataString); const hash = params.get('hash'); if (!hash) return false; params.delete('hash'); const pairs: string[] = []; for (const [key, value] of params.entries()) { pairs.push(`${key}=${value}`); } pairs.sort(); const dataCheckString = pairs.join('\n'); const secretKeyHash = crypto.createHmac('sha256', 'WebAppData').update(secretKey).digest(); const calculatedHash = crypto.createHmac('sha256', secretKeyHash).update(dataCheckString).digest('hex'); return calculatedHash === hash; }
Python 3.10+
import hmac import hashlib from urllib.parse import parse_qsl def validate_sociq_init_data(init_data: str, secret_key: str) -> bool: parsed = dict(parse_qsl(init_data)) if 'hash' not in parsed: return False received_hash = parsed.pop('hash') check_string = "\n".join(f"{k}={v}" for k, v in sorted(parsed.items())) secret_key_hash = hmac.new(b"WebAppData", secret_key.encode(), hashlib.sha256).digest() calculated = hmac.new(secret_key_hash, check_string.encode(), hashlib.sha256).hexdigest() return hmac.compare_digest(calculated, received_hash)
Go 1.20+
package auth import ( "crypto/hmac" "crypto/sha256" "encoding/hex" "net/url" "sort" "strings" ) func ValidateSociqInitData(initData, secretKey string) bool { values, _ := url.ParseQuery(initData) hash := values.Get("hash") if hash == "" { return false } values.Del("hash") var pairs []string for k, v := range values { pairs = append(pairs, k+"="+v[0]) } sort.Strings(pairs) checkString := strings.Join(pairs, "\n") h1 := hmac.New(sha256.New, []byte("WebAppData")) h1.Write([]byte(secretKey)) secretHash := h1.Sum(nil) h2 := hmac.New(sha256.New, secretHash) h2.Write([]byte(checkString)) expectedHash := hex.EncodeToString(h2.Sum(nil)) return hmac.Equal([]byte(expectedHash), []byte(hash)) }
Глава 5

Разработка Ботов и входящие Webhooks

Приём сообщений и событий платформы с валидацией заголовка X-Sociq-Signature

Когда пользователь отправляет сообщение боту или упоминает его, шлюз Sociq немедленно отправляет HTTP POST запрос на указанный вами Webhook URL.

Проверка подлинности вебхука:

Каждый запрос сопровождается заголовком X-Sociq-Signature: sha256=<hmac>, вычисленным по секретному токену вашего бота от сырого тела входящего запроса:

PHP Webhook Handler
$rawBody = file_get_contents('php://input'); $signatureHeader = $_SERVER['HTTP_X_SOCIQ_SIGNATURE'] ?? ''; $expectedSignature = 'sha256=' . hash_hmac('sha256', $rawBody, $botSecretToken); if (!hash_equals($expectedSignature, $signatureHeader)) { http_response_code(403); exit(json_encode(['error' => 'Invalid signature'])); } $event = json_decode($rawBody, true); $messageText = $event['message']['text'] ?? ''; $senderId = $event['message']['from_id'] ?? 0; // Ответ ботом пользователю http_response_code(200); echo json_encode([ 'action' => 'send_message', 'text' => 'Привет! Я получил ваше сообщение: ' . $messageText ]);
Глава 6

Справочник методов REST API (v1)

Базовый шлюз: https://my45.ru/api/v1/platform

GET /api/v1/platform?action=users_get
Scope: users.read_basic

Возвращает публичный профиль пользователя по его идентификатору.

Параметры запроса:
ПараметрТипОбязательныйОписание
user_id integer Да Числовой идентификатор аккаунта пользователя
Пример cURL
curl -X GET "https://my45.ru/api/v1/platform?action=users_get&user_id=12" \ -H "Authorization: Bearer atk_your_access_token"
POST /api/v1/platform?action=posts_create
Scope: posts.create

Публикует новую запись на стене от имени авторизованного приложения.

Параметры запроса (POST form-data или JSON):
ПараметрТипОбязательныйОписание
message string Да Текст публикации (от 1 до 5000 символов)
Пример cURL
curl -X POST "https://my45.ru/api/v1/platform" \ -H "Authorization: Bearer atk_your_access_token" \ -d "action=posts_create" \ -d "message=Запись опубликована через Sociq Platform API!"
POST /api/v1/platform?action=notifications_send
Scope: notifications.send

Отправляет системное колокольчик-уведомление конкретному пользователю.

Пример cURL
curl -X POST "https://my45.ru/api/v1/platform" \ -H "Authorization: Bearer atk_your_access_token" \ -d "action=notifications_send" \ -d "user_id=12" \ -d "text=Ваш заказ успешно обработан!" \ -d "link=/app/myshop"
Глава 7

Каталог разрешений (Scopes & RBAC)

Матрица разграничения доступа для API-ключей и приложений

Идентификатор (Scope) Название Описание Уровень риска
users.read_basic Базовый профиль Чтение публичных полей: ID, имя, никнейм, аватар Низкий
users.read_profile Расширенный профиль Дата рождения, пол, дата регистрации, город Средний
posts.create Публикация постов Размещение записей на стене пользователя Повышенный
comments.create Комментарии Оставление комментариев под публикациями Повышенный
notifications.send Отправка уведомлений Доставка оповещений в колокольчик пользователя Средний
reports.create Подача жалоб Отправка сигналов о нарушениях в модерацию Низкий
Глава 8

Интерактивная API Консоль (Тестовый стенд)

Выполняйте реальные запросы к шлюзу платформы прямо из браузера

API Test Console
Sandbox Mode
Глава 9

Обработка ошибок и Rate Limiting

Форматы статусных кодов и лимиты шлюза платформы

Код HTTP Статус Описание ошибки
400 Bad Request Отсутствуют обязательные параметры запроса или некорректный JSON.
401 Unauthorized Не передан или истёк Bearer токен в заголовке Authorization.
403 Forbidden Токен валиден, но не обладает необходимым разрешением (Scope).
404 Not Found Запрошенный ресурс (пользователь, приложение или метод) не найден.
429 Too Many Requests Превышен лимит запросов (базовый лимит: 5 000 запросов в минуту на Client ID).
Яндекс.Метрика