Консоль разработчика
В Консоли разработчика trucklinemp.com/developer вы управляете ключами API, приложениями OAuth, вебхуками и телеметрией интеграций.
Сначала включите доступ: Обзор платформы для разработчиков. Режим разработчика остается включенным навсегда после активации.
Макет консоли
Заголовок раздела «Макет консоли»Боковая панель разделена на четыре области:
| Страница | Назначение |
|---|---|
| Панель управления | Карточки обзора проектов, быстрые ссылки |
| Все проекты | Список, поиск и создание проектов |
API и Сервисы
Заголовок раздела «API и Сервисы»| Страница | Назначение |
|---|---|
| Ключи API | Создание и отзыв ключей tlmp_api_ для каждого проекта |
| Приложения OAuth | Регистрация и настройка приложений OAuth |
| Вебхуки | Подписка на push-уведомления о событиях платформы |
| Библиотека API | Встроенный ReDoc для /api/v1/openapi.json |
| Тестовая среда | Отправка тестовых запросов из браузера |
Управление
Заголовок раздела «Управление»| Страница | Назначение |
|---|---|
| Аналитика | Объем запросов, ошибки, задержка, популярные эндпоинты |
| Квоты использования | Отображение уровня лимитов, пикового использования, флагов подозрительной активности |
| Журналы аудита | Журнал каждого запроса с IP, статусом, срабатываниями ограничения скорости |
Ресурсы
Заголовок раздела «Ресурсы»| Страница | Назначение |
|---|---|
| Журнал изменений API | Опубликованная история изменений API |
| Каталог приложений | Просмотр публичных приложений OAuth, жалобы на нарушения |
Проекты
Заголовок раздела «Проекты»- Максимум 5 проектов на аккаунт разработчика
- Каждый проект имеет свои собственные ключи API и приложения OAuth
- Выберите активный проект в заголовке; выбор сохраняется в хранилище браузера
- Многие страницы принимают
?project={id}в URL-адресе
Создайте проект перед генерацией ключей или учетных данных OAuth.
Ключи API
Заголовок раздела «Ключи API»- Префикс:
tlmp_api_(в старых ключах может по-прежнему использоваться устаревший префиксtl_) - Максимум 10 активных ключей на проект
- Секрет показывается один раз при создании
- Доступ только для чтения к публичным данным REST плюс более высокие ограничения скорости
- Немедленно отзывайте скомпрометированные ключи из консоли
См. Публичный API.
Приложения OAuth
Заголовок раздела «Приложения OAuth»- Максимум 5 приложений OAuth на проект
- Префикс ID клиента:
tlmp_client_ - Неопубликованные приложения требуют наличия тестовых пользователей для авторизации
- Публикация может потребовать проверки персоналом
См. Приложения OAuth.
Вебхуки
Заголовок раздела «Вебхуки»- Максимум 10 вебхуков на аккаунт разработчика (привязаны к пользователю, а не к проекту)
- Только эндпоинты HTTPS
- Выполняйте ротацию секретов подписи из консоли в случае компрометации
См. Вебхуки.
Аналитика и аудит
Заголовок раздела «Аналитика и аудит»Аналитика сводит данные о трафике для выбранного проекта: графики на временной шкале, уровень ошибок, проценты задержки, а также самые популярные эндпоинты или ключи.
Журналы аудита отображают отдельные запросы с указанием метода, пути, кода состояния, user agent и информации о срабатывании ограничения скорости. Фильтруйте по временному диапазону и статусу. Используйте это для отладки интеграций и ложных срабатываний систем защиты от злоупотреблений.
Квоты показывают ваш текущий уровень API (free, basic, premium, unlimited), действующие ограничения и любое состояние защиты от злоупотреблений. Повышение уровня назначается персоналом; свяжитесь с поддержкой для коммерческих нужд.
Тестовая среда
Заголовок раздела «Тестовая среда»Тестовая среда загружает актуальную спецификацию OpenAPI и позволяет прикрепить сохраненный в сессии ключ API, чтобы протестировать эндпоинты на том же /api/v1. Это полезно перед написанием клиентского кода.
Каталог приложений
Заголовок раздела «Каталог приложений»Опубликованные приложения OAuth появляются в каталоге для поиска. Пользователи могут искать приложения и жаловаться на подозрительные списки. Поддерживайте актуальность вашей политики конфиденциальности и URL-адресов веб-сайтов на странице Общие вашего приложения OAuth.
Журнал изменений API
Заголовок раздела «Журнал изменений API»Персонал публикует записи в журнале изменений (новые функции, устаревшие элементы, критические изменения). Разработчики читают их в консоли. Самостоятельная публикация для третьих лиц не предусмотрена.
Чего нет в консоли
Заголовок раздела «Чего нет в консоли»Следующее не является поверхностями для сторонних интеграций:
| Поверхность | Примечания |
|---|---|
/api/rpc |
Внутренний oRPC только для пользовательского интерфейса веб-сайта |
/api/v1/mobile/* |
Собственное мобильное приложение |
/api/v1/launcher/* |
Лаунчер игры |
| Админ-процедуры | Проверки и изменения уровней только для персонала |
Используйте публичный API и OAuth, задокументированные в этом разделе документации.
Сводка лимитов
Заголовок раздела «Сводка лимитов»| Ресурс | Лимит |
|---|---|
| Проектов на аккаунт | 5 |
| Ключей API на проект | 10 |
| Приложений OAuth на проект | 5 |
| Вебхуков на аккаунт | 10 |