API - gps-ua.org

GPS-UA.ORG

Руководство для использования API Сервисов GPS-UA.ORG

Что такое API
Использование API
Ограничения

API - это набор функций для разработчиков, позволяющий писать свои собственные приложения, используя данные из наших сервисов. При разработке програмного обеспечения с использованием API используется подход "черного ящика", конечная программа не зависит от внутренней реализации API, а только использует полученные данные.
Подробнее на Wikipedia

2. Использование API

Для получения данных с помощью API используется GET запрос к сервису и личный ключ API который можно получить на текущей странице.
Форма запроса:

https://gps-ua.org/api/{apiname}/?key={yourkey}&format={json|xml|image|redirect}&device={*|id}

Например:

https://gps-ua.org/api/location/?key=demo&format=json&device=*

На данный момент доступно два сервиса API: Staticmap и Location

Staticmap

Позволяет получить изображение или ссылку на изображение на сервисе Statiсmap от Google.
Форма запроса:

https://gps-ua.org/api/staticmap/?key={yourkey}&format={json|xml|image|redirect}&device={id}
&height={height:px}&width={width:px}&time={time:sec}

Параметры:

key (обязательный) Ваш личный ключ API.
format (не обязательный, json по умолчанию) Формат возвращаемых данных. Допустимые форматы: json, xml, image (возвращает изображение с соответствующим MIME типом), redirect (возвращает заголовок перенаправления страницы на изображение карты)
device (не обязательный, первое устройство по умолчанию) ID устройства.
height (не обязательный, 200 по умолчанию) Высота изображения в пикселях. Минимум 200, максимум 600.
width (не обязательный, 200 по умолчанию) Ширина изображения в пикселях. Минимум 200, максимум 600.
time (не обязательный, 30 по умолчанию) Время захватываемого "хвоста" устройства. В секундах, максимум 1200.

Пример результата:

https://gps-ua.org/api/staticmap/?key=demo&format=image&device=2&height=300&width=300&time=600

Ограничения:
На Staticmap действуют ограничения сервиса Google (1000 уникальных запросов от одного клиента в день), а также наши ограничения описанные в разделе Ограничения

Location

Позволяет получить расплолжение, скорость и направление объектов.
Форма запроса:

https://gps-ua.org/api/location/?key={yourkey}&format={json|xml}&device={*|id}

Параметры:

key (обязательный) Ваш личный ключ API.
format (не обязательный, json по умолчанию) Формат возвращаемых данных. Допустимые форматы: json, xml
device (не обязательный, первое устройство по умолчанию) ID устройства или знак "*" - все устройства.

Пример результата:

https://gps-ua.org/api/location/?key=demo&format=json&device=*

		{
			"2":{
				"name":"Test \"B\"",
				"id":"2",
				"X":"50.4332366585732",
				"Y":"30.3745699822903",
				"Z":"203",
				"speed":0,
				"direction":0,
				"nodeName":"device"
			},
			"8":{
				"name":"Deltaplane",
				"id":"8",
				"X":"50.5299999713898",
				"Y":"26.2571133375168",
				"Z":"225",
				"speed":0,
				"direction":0,
				"nodeName":"device"
			},
			"9":{
				"name":"Android",
				"id":"9",
				"X":"56.85420393",
				"Y":"14.82366898",
				"Z":"207",
				"speed":1.8,
				"direction":96,
				"nodeName":"device"
			}
		}

Attach photo New!

Photo - отдельный API, позволяющий прикреплять фото к устройству.
Форма GET запроса:

https://gps-ua.org/api/photo/?format={json|xml}

Авторизация устройства происходит по IMEI и паролю устройства, вместе с ними отправляется время фотографии и само изображение. Запрос должен соответствовать браузерным стандартам для форм multipart/form-data. Фотография привязывается к ближайшей точке назад во времени.

Данные передаются в виде POST запроса.
Параметры:

format (не обязательный GET параметр) Формат ответа. Допустимые форматы: json, xml
device (обязательный) IMEI устройства.
password (обязательный) индивидуальный пароль устройства.
photo (обязательный) Фотография.
time (не обязательный, текущее время по умолчанию) Время в формате Unixtime, когда сделан снимок.

3. Ограничения

В целях безопасности на сервис API налагается ряд ограничений:

IP клиентов от которых приходят частые запросы с неправильным API-key будут временно заблокированы.
IP клиентов от которых будет приходить слишком большое кол-во запросов будут временно заблокированы во избежание злоупотреблений. При повторном нарушении возможна блокировака на постоянной основе. Снятие этого ограничения обсуждается индивидуально с каждым пользователем.
При использовании API Photo одпускается один запрос с одного IP в 3 секунды.