Авторизация
Для работы с API необходим ключ доступа. Ключ можно получить в личном кабинете платформы CityAir в разделе «Настройки» -> «Ключи доступа API». Или же посредством обращения в службу поддержки.
Доступ к данным
Ключи доступа выдаются на пользователя. Доступ с использованием API к оборудованию, постам мониторинга и их измерениям соотвествует доступу в личном кабинете пользователя и его роли в каждом личном кабинете.
| Роль | Права |
|---|---|
| Администратор | Полный доступ к оборудованию и постам на чтение |
| Оператор | Полный доступ к оборудованию и постам на чтение |
| Наблюдатель | Доступ к явно назначенным постам мониторинга |
При наличии доступа к нескольким личным кабинетам в ответе будут содержаться данные из всех, с учетом роли пользователя.
Передача ключей при запросе
Ключ передается в HTTP-заголовке Authorization. Для совместимости с будущими изменениями ключ передается как Bearer Token.
Пример:
curl -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" https://mycityair.ru/harvester/v2/Posts
Рекомендации
- При передаче API-ключа используйте https-соединение.
- Если вы подозреваете, что API-ключ скомпроментирован, вы можете выпустить новый и удалить старый в личном кабинете.