Geomixer REST API
REST API GeoMixer — интерфейс для взаимодействия пользовательского приложения и сервера GeoMixer с помощью протокола HTTP(S).
Интерфейс позволяет приложению выполнять различные манипуляции со своими данными — слоями, объектами, файлами, картами.
API-ключ
Для выполнения операций и контроля доступа все запросы должны быть аутентичны. Для этого пользователь должен добавить в качестве параметра запроса свой прямой API-ключ.
Для получения ключа необходимо войти под зарегистрированной учетной записью и выбрать элемент меню Личный кабинет:
Далее необходимо выбрать пункты Разработчикам и затем API-ключ прямого доступа (для приложений):
После нажатия на кнопку Получить новый ключ необходимо ознакомиться и согласиться с условиями использования.
После этого, необходимо еще раз открыть пункты меню Разработчикам и Список API-ключей, в списке должен появиться созданный ключ прямого доступа:
Вызовы API
Вызовы осуществляются посредством HTTP/HTTPS-запросов.
В качестве методов могут быть использованы POST и GET – различий между ними на данный момент нет.
Методы PUT и DELETE не поддерживаются.
Параметры могут быть переданы как в URL, так и в теле POST-запроса.
Результат выполнения операции содержится в коде состояния HTTP. Перечень возможных кодов приведен в таблице:
Код результата | Когда используется |
---|---|
200 OK | Возвращается в случае успешно выполненной операции, тело, как правило, содержит дополнительную информацию. |
400 Bad Request | Возвращается в случае, если в запросе содержится ошибка, например, неправильно задан один из параметров. |
403 Forbidden | Возвращается в случае не авторизованного доступа (когда для доступа необходим API-ключ, но он не указан либо указан неправильный ключ). |
404 Not Found | Возвращается в случае, если не найден какой-либо объект, участвующий в запросе, например, слой. |
500 Internal Server Error | Возвращается в случае ошибки, произошедшей при работе сервера. |
501 Not Implemented | Возвращается в случае, если запрошенная операция не реализован |