Получение API Keys

Используйте эту страницу, когда вам нужны учётные данные для вызова WLTE OpenAPI.

Где создать API Key

1. Войдите в Developer Console: https://developer.svnwi.com/wlte
2. Откройте своё приложение.
3. Перейдите в раздел управления API Client.
4. Создайте API Client.
5. Выберите минимально необходимые для вашей интеграции области доступа (scopes).
6. Сохраните сгенерированные clientId и clientSecret.

В Developer Console API key создаётся как API Client. После создания вы получаете два значения:

Значение	Назначение
clientId	Публичный идентификатор API Client
clientSecret	Секрет, который ваш сервер использует для запроса access token

Вместе clientId и clientSecret — это учётные данные, которые вы используете для получения access token.

Что управляется через Developer Console

Раздел	Назначение
API Keys	Создание API Client и получение clientId / clientSecret
Права доступа	Контроль того, к каким устройствам и операциям может обращаться интеграция
Жизненный цикл учётных данных	Смена, отключение или удаление учётных данных
Решение проблем	Использование ID клиента, ID запроса и временных меток при обращении в поддержку

Как используется ключ

Ваш сервер обменивает учётные данные на короткоживущий access token:

POST /wlte/v1/auth/token

Затем ваш сервер вызывает REST API с этим токеном:

Authorization: Bearer {accessToken}

Не вызывайте API устройств напрямую с помощью clientSecret. Секрет используется только для запроса access token.

Обязательные правила безопасности

• Храните clientSecret только в защищённом хранилище секретов на стороне сервера.
• Не размещайте clientSecret в коде браузера, мобильных приложениях, публичных репозиториях, скриншотах или логах.
• clientSecret отображается только при создании или смене. Сохраните его немедленно.
• Если секрет утерян, замените его. Исходное значение повторно увидеть нельзя.
• По возможности используйте отдельные API Client для продакшна, staging и локального тестирования.
• Отключайте неиспользуемые API Client.

Права доступа

Области доступа (scopes) определяют, что может делать API Key. Например, ключ только для чтения не может управлять реле или изменять конфигурацию устройства.

Если вызов API возвращает AUTH_SCOPE_DENIED, обновите области доступа API Client в Developer Console, сохраните изменение, получите новый access token и повторите попытку.

См. Права доступа и безопасность.

Поведение при смене и отключении

Изменения жизненного цикла учётных данных применяются сервером API:

Изменение	Ожидаемое поведение
Секрет заменён	Старый секрет больше не может запрашивать новые токены
API Client отключён	Запросы новых токенов завершаются неудачей, защищённые API отклоняют существующие токены
API Client удалён	Запросы новых токенов завершаются неудачей, защищённые API отклоняют существующие токены
Права доступа изменены	Существующие токены проверяются на соответствие текущим правам доступа

Планируйте смену секретов так, чтобы ваш сервер был обновлён до прекращения приёма старого секрета.