В данном репозитории представлено описание работы с HTTP API портала iridium360.ru
Вы можете использовать этот API для интеграции портала iridium360.ru в ваш сервис, сайт или приложение
Для работы с API вам необходимо получить токен в настройках вашего аккаунта на портале iridium360.ru
- Войдите в личный кабинет iridium360.ru
- Перейдите на страницу настроек аккаунта
- В разделе
APIвключите Разрешить API - Нажмите кнопку Получить новый токен API
Проверить работу API прямо из браузера можно по ссылке Swagger UI
GET https://service.iridium360.ru/rockstar-public/api/v1/account
| Имя | Расположение | Тип | Обязательный | Описание |
|---|---|---|---|---|
| service-session | header | string | да | API токен |
| Код | Статус | Описание | Формат ответа |
|---|---|---|---|
| 200 | OK | Success | array [ApiAccountView] |
Пример ответа
{
"username": "Иван Иванов",
"email": "example@mail.ru",
"phone": "+79153925491",
"avatar": "https://www.iridium360.ru/api/images/raw/270b62759cf0438aacbd0304503225e0/209c61991f9c4af682d034442f746b12_M"
}GET https://service.iridium360.ru/rockstar-public/api/v1/devices
Будут возвращены устройства, владельцем которых является текущий аккаунт, а также устройства, к которым был предоставлен доступ от других аккаунтов
| Имя | Расположение | Тип | Обязательный | Описание |
|---|---|---|---|---|
| service-session | header | string | да | API токен |
| Код | Статус | Описание | Формат ответа |
|---|---|---|---|
| 200 | OK | Success | array [ApiDeviceView] |
Пример ответа
[
{
"id": "02IaVXbMpE6I06TgG5sWFA",
"time": "2021-01-24T14:15:22Z",
"serialNumber": "10976",
"imei": "1088310395832939554821",
"lastLocation": {
"lat": -19.85858,
"lon": 141.00531,
"date": "2021-01-23T08:01:54Z",
"alt": 3
},
"owner" : {
"email": "example@email.com",
},
"accessType": "Full"
},
{
"id": "UgaL41FWQ0qx0Z4CK5jssA",
"time": "2021-01-24T14:15:22Z",
"serialNumber": "209356",
"imei": "1088310383288683021",
"lastLocation": {
"lat": -42.792091,
"lon": 146.909608,
"date": "2021-01-23T08:01:54Z",
"alt": 12
},
"owner" : {
"email": "somebody@email.com",
},
"accessType": "Readonly"
},
{
"id": "l7D4XDcIq0mZdCNBWm3yhA",
"time": "2021-01-24T14:15:22Z",
"serialNumber": "509382",
"imei": "1049284103856105938",
"lastLocation": {
"lat": -39.327232,
"lon": 175.659989,
"date": "2021-01-23T02:12:28Z",
"alt": 9
}
}
]GET https://service.iridium360.ru/rockstar-public/api/v1/devices/{id}
**Данный метод принимает id или серийный номер. По id можно получить устройства, которыми владеет текущий аккаунт, а также устройства к которым предоставлен доступ. Это рекомендуемый способ.
По серийному номеру можно получить только устройства, владельцем которых является текущий аккаунт. Это устаревший способ.
Это правило распространяется и на остальные API методы
| Имя | Расположение | Тип | Обязательный | Описание |
|---|---|---|---|---|
| id | path | string | да | Id устройства** |
| service-session | header | string | да | API токен |
| Код | Статус | Описание | Формат ответа |
|---|---|---|---|
| 200 | OK | Success | ApiDeviceView |
Пример ответа
{
"id": "UgaL41FWQ0qx0Z4CK5jssA",
"time": "2021-01-24T14:15:22Z",
"serialNumber": "209356",
"imei": "1088310383288683021",
"lastLocation": {
"lat": -42.792091,
"lon": 146.909608,
"date": "2021-01-23T08:01:54Z",
"alt": 12
},
"owner" : {
"email": "example@email.com",
},
"accessType": "Full"
}GET https://service.iridium360.ru/rockstar-public/api/v1/points
| Имя | Расположение | Тип | Обязательный | Описание |
|---|---|---|---|---|
| id | query | string | да | Id устройства** |
| start | query | string(date-time) | нет | Дата (вкл) с которой выдать точки |
| end | query | string(date-time) | нет | Дата (вкл) до которой выдать точки |
| count | query | integer(int32) | нет | Максимальное кол-во выдаваемых точек |
| service-session | header | string | да | API токен |
| Код | Статус | Описание | Формат ответа |
|---|---|---|---|
| 200 | OK | Success | array [ApiDevicePointView] |
Пример ответа
[
{
"id": "w7oUijvyIECNJPl2pFNnzg",
"location": {
"lat": -19.858583,
"lon": 141.005343,
"date": "2021-01-25T14:15:22Z",
"alt": 2,
"sog": 0.1852,
"cog": 0,
"sogInstantaneous": 0.1852,
"cogInstantaneous": 0
}
},
{
"id": "w7oUijvyIECNJPl2pFNnzg",
"location": {
"lat": -19.85858,
"lon": 141.00531,
"date": "2021-01-24T08:01:54Z",
"alt": 3,
"sog": 0,
"cog": 0,
"sogInstantaneous": 0,
"cogInstantaneous": 0
}
},
{
"id": "W0LBoaFjKkCiSavE8ehTPQ",
"location": {
"lat": -19.85855,
"lon": 141.00529,
"date": "2021-01-24T04:32:19Z",
"alt": 2,
"sog": 0.0572,
"cog": 0.2101,
"sogInstantaneous": 0.0572,
"cogInstantaneous": 0.2101
}
}
]GET https://service.iridium360.ru/rockstar-public/api/v1/points/{id}
| Имя | Расположение | Тип | Обязательный | Описание |
|---|---|---|---|---|
| id | path | string | да | Id точки |
| service-session | header | string | да | API токен |
| Код | Статус | Описание | Формат ответа |
|---|---|---|---|
| 200 | OK | Success | ApiDevicePointView |
Пример ответа
{
"id": "YEAJoY2FdUiSN8itgj3d3Q",
"location": {
"lat": -19.85858,
"lon": 141.00531,
"date": "2021-01-24T08:01:54Z",
"alt": 3,
"sog": 0.1244,
"cog": 0.0569,
"sogInstantaneous": 0.1244,
"cogInstantaneous": 0.0569
}
}GET https://service.iridium360.ru/rockstar-public/api/v1/messages
| Имя | Расположение | Тип | Обязательный | Описание |
|---|---|---|---|---|
| id | query | string | да | Id устройства** |
| startId | query | string | нет | Id сообщения (включительно), начиная с которого нужно выдать сообщения |
| endId | query | string | нет | Id сообщения (включительно), до которого нужно выдать сообщения |
| count | query | integer(int32) | нет | Кол-во сообщений (по умолчанию 50) |
| service-session | header | string | да | API токен |
Передав только параметр
startIdбудут выданы сообщения "вверх" по хронологии начиная с указанного. Передав только параметрendIdбудут выданы сообщения "вниз" по хронологии начиная с указанного.
Параметр
countигнорируется, если переданы оба параметраstartIdиendId
| Код | Статус | Описание | Формат ответа |
|---|---|---|---|
| 200 | OK | Success | array [ApiMessageView] |
Пример ответа
[
{
"id": "oyYFZZaGDUmt3R7iUItuyg",
"date": "2021-01-24T14:15:22Z",
"text": "сообщение с устройства на портал",
"direction": "FromDevice",
"location": {
"lat": -19.858583,
"lon": 141.005343,
"date": "2021-01-24T14:13:15Z",
"alt": 2
}
},
{
"id": "yacgLXd4sUGJaNiZmdfhAQ",
"date": "2021-01-24T14:15:22Z",
"text": "сообщение с устройства на мобильный",
"direction": "FromDevice",
"location": {
"lat": -19.858583,
"lon": 141.005343,
"date": "2021-01-24T14:13:15Z",
"alt": 2
},
"childs": [
{
"id": "gnbX6EfGX0SSQavaUkhUkA",
"date": "2021-01-24T14:15:22Z",
"text": "сообщение с устройства на мобильный",
"direction": "FromDevice",
"subscriber": "79153925491",
"location": {
"lat": -19.858583,
"lon": 141.005343,
"date": "2021-01-24T14:13:15Z",
"alt": 2
}
}
]
},
]GET https://service.iridium360.ru/rockstar-public/api/v1/messages/{id}
| Имя | Расположение | Тип | Обязательный | Описание |
|---|---|---|---|---|
| id | path | string | да | Id сообщения |
| service-session | header | string | да | API токен |
| Код | Статус | Описание | Формат ответа |
|---|---|---|---|
| 200 | OK | Success | ApiMessageView |
Пример ответа
{
"id": "yacgLXd4sUGJaNiZmdfhAQ",
"date": "2021-01-24T14:15:22Z",
"text": "сообщение с устройства на мобильный",
"direction": "FromDevice",
"location": {
"lat": -19.858583,
"lon": 141.005343,
"date": "2021-01-24T14:13:15Z",
"alt": 2
},
"childs": [
{
"id": "gnbX6EfGX0SSQavaUkhUkA",
"date": "2021-01-24T14:15:22Z",
"text": "сообщение с устройства на мобильный",
"direction": "FromDevice",
"subscriber": "79153925491",
"location": {
"lat": -19.858583,
"lon": 141.005343,
"date": "2021-01-24T14:13:15Z",
"alt": 2
}
}
]
}POST https://service.iridium360.ru/rockstar-public/api/v1/messages/send
Сообщение будет отправлено в приложение Iridium360° Connect (скачать для Android и iOS)
| Имя | Расположение | Тип | Обязательный | Описание |
|---|---|---|---|---|
| id | query | string | да | Id устройства** |
| from | query | string | да | Отправитель сообщения (email или мобильный номер)* |
| service-session | header | string | да | API токен |
| - | body | string | да | Текст сообщения |
*По умолчанию можно указать только email или верифицированный мобильный номер аккаунта, которому принадлежит API токен. Для отправки сообщений используя чужой номер или email обратитесь в поддержку support@iridium360.ru
| Код | Статус | Описание | Формат ответа |
|---|---|---|---|
| 200 | OK | Success | ApiMessageView |
Пример ответа
{
"id": "VzOZYD0KNUWZ6TxDqHqFpw",
"date": "2021-01-26T14:15:22Z",
"text": "привет! как дела?",
"direction": "ToDevice",
"subscriber": "79153925491"
}Структура, содержащая информацию об аккаунте
{
"username": "string",
"email": "string",
"phone": "string",
"avatar": "string"
}
| Имя | Тип | Обязательный | Описание |
|---|---|---|---|
| username | string | да | Имя пользователя |
| string | да | ||
| phone | string | нет | Номер мобильного телефона |
| avatar | string | нет | Ссылка на аватар |
Структура, содержащая информацию о точке устройства
{
"id": "string",
"location": {
"lat": 0,
"lon": 0,
"date": "2019-08-24T14:15:22Z",
"alt": 0
}
}
| Имя | Тип | Обязательный | Описание |
|---|---|---|---|
| id | string | да | Id точки |
| location | Location | да | Координаты точки |
Структура, содержащая информацию об устройстве
{
"id": "UgaL41FWQ0qx0Z4CK5jssA",
"time": "2019-08-24T14:15:22Z",
"serialNumber": "string",
"imei": "string",
"lastLocation": {
"lat": 0,
"lon": 0,
"date": "2019-08-24T14:15:22Z",
"alt": 0
},
"owner" : {
"email": "string",
},
"accessType": "Full"
}
| Имя | Тип | Обязательный | Описание |
|---|---|---|---|
| id | string | да | Id устройства** |
| time | string(date-time) | да | Дата актуальности данных |
| serialNumber | string | да | Серийный номер устройства |
| imei | string | да | IMEI устройства |
| lastLocation | Location | нет | Последнее известное местоположение устройства |
| owner | ApiAccountView | нет | Владелец устройства* |
| accessType | DeviceAccessType | нет | Доступ к устройству* |
*Будет возвращена информация о владельце и предоставленных правах доступа к устройству, если текущий аккаунт не является владельцем устройства
Структура, содержащая информацию о сообщении
{
"id": "string",
"date": "2019-08-24T14:15:22Z",
"text": "string",
"direction": "FromDevice",
"subscriber": "string",
"location": {
"lat": 0,
"lon": 0,
"date": "2019-08-24T14:15:22Z",
"alt": 0
},
"childs": []
}
| Имя | Тип | Обязательный | Описание |
|---|---|---|---|
| id | string | да | Id сообщения |
| date | string(date-time) | да | Дата получения / отправки |
| text | string | да | Текст сообщения |
| direction | MessageDirection | да | Направление сообщения |
| subscriber | string | нет | Отправитель / получатель |
| location | Location | да | Координаты отправки сообщения |
| childs | array [ApiMessageView] | нет | Дочерние сообщения* |
*Одно сообщение, отправленное с устройства может быть доставлено нескольким получателям (например, на мобильный телефон и email) в завимости от настроек в личном кабинете
Структура, содержащая координаты
{
"lat": 0,
"lon": 0,
"date": "2019-08-24T14:15:22Z",
"alt": 0
}
| Имя | Тип | Обязательный | Описание |
|---|---|---|---|
| lat | number(double) | да | Широта |
| lon | number(double) | да | Долгота |
| date | string(date-time) | да | Дата |
| alt | number(double) | нет | Высота |
Направление сообщения
| Значение | Описание |
|---|---|
| FromDevice | Сообщение с устройства |
| ToDevice | Сообщение на устройство |
Доступ к устройству
| Значение | Описание |
|---|---|
| Readonly | Только просмотр. Имеет доступ «только чтение» к тем устройствам, к которым ему дал доступ владелец |
| Full | Полный доступ. Имеет доступ ко всем устройствам, к которым ему дал доступ владелец |