Обзор платформы для разработчиков

TrucklineMP предлагает платформу для разработчиков для сторонних интеграций. Вы можете читать публичные данные платформы через Public API, идентифицировать пользователей с помощью OAuth 2.0 и получать обновления в реальном времени через вебхуки.

Эта документация охватывает концепции и рабочие процессы. Для получения полного списка эндпоинтов, форматов запросов и схем ответов используйте интерактивный справочник по API на главном сайте.

Что вы можете создать

Интеграция	Лучше всего подходит для
Public API	Ботов, панелей управления, сайтов со статистикой и инструментов, которые читают данные VTC, мероприятий, новостей, пользователей и модерации
OAuth apps	Приложений, которые авторизуют пользователей через их аккаунт TrucklineMP и читают данные профиля в рамках выделенных областей доступа
Webhooks	Сервисов, которые реагируют на события платформы (вступления участников, баны, ответы на приглашения и многое другое)

Перед тем как начать

Создайте аккаунт TrucklineMP на сайте trucklinemp.com.
Включите Developer Mode по пути Account Settings → Security → Developer Mode → Activate.
Откройте Консоль разработчика из панели навигации или настроек безопасности.

Режим разработчика открывает доступ к консоли. Сам по себе он не предоставляет расширенных разрешений API. Публичные эндпоинты API остаются доступными только для чтения. Области доступа OAuth контролируют, к каким пользовательским данным ваше приложение может получить доступ после того, как пользователь его авторизует.

Быстрый старт: Публичный API

В Консоли разработчика создайте проект (project).
Сгенерируйте ключ API (префикс tlmp_api_...). Скопируйте его, когда он отобразится. Позже его нельзя будет просмотреть.
Отправьте запрос с вашим ключом:

curl -H "Authorization: Bearer tlmp_api_YOUR_API_KEY" \
  "https://api.trucklinemp.com/vtcs"

Опробуйте эндпоинты в интерактивном режиме в API Playground.

Публичные эндпоинты для чтения работают без ключа API. Ключи повышают ваши лимиты запросов и привязывают использование к вашему проекту для аналитики.

Быстрый старт: Приложение OAuth

В Консоли разработчика перейдите в раздел OAuth Apps и создайте приложение.
Укажите redirect URIs и scopes на странице настроек OAuth.
Скопируйте ссылку для установки install link со страницы обзора приложения (или создайте собственный URL авторизации).
Пока приложение не опубликовано, добавьте тестовых пользователей test users, чтобы другие могли авторизовать его во время разработки.
Когда всё будет готово, пройдите верификацию домена и опубликуйте приложение через страницу публикации.

Смотрите раздел Приложения OAuth для получения полной информации о потоке авторизации, PKCE и правилах публикации.

Где найти справочник по API

Канонический справочник по эндпоинтам генерируется из актуальной спецификации OpenAPI:

Ресурс	URL
OpenAPI JSON	trucklinemp.com/api/v1/openapi.json
Интерактивный справочник	/ru/web-api/public-api/doc (Swagger UI)
Документация консоли	trucklinemp.com/developer/docs
Тестовая среда	trucklinemp.com/developer/playground

Карта документации

Руководство	Темы
Публичный API	Аутентификация, базовые URL-адреса, лимиты запросов, обзор эндпоинтов
TypeScript SDK	Установка `@trucklinemp/sdk`, использование клиента, ошибки, проверка вебхуков
Приложения OAuth	Поток авторизации, области доступа, информацию о пользователях, тестовые пользователи, PKCE, публикация
Вебхуки	Подписки, подписи, повторные попытки, каталог событий
Консоль разработчика	Проекты, аналитика, журналы аудита, квоты, тестовая среда
Утечка API-ключей и секретов	Что делать, если ключ или секрет был опубликован в открытом доступе

Конфиденциальность и соответствие требованиям

Использование API логируется для ограничения количества запросов, предотвращения злоупотреблений и аналитики. О том, как обрабатывается телеметрия, читайте в Политике конфиденциальности.

Приложения OAuth обязаны предоставлять ссылку на политику конфиденциальности и должны предоставлять ссылку на условия использования перед публикацией.