EverGIS API

Работа EverGIS API основывается на выполнении сервером каждой элементарной операции после получения соответсвующего ей HTTP-запроса, содержащего необходимые параметры и данные.

Основные HTTP-методы, используемые EverGIS API:

  • GET - запрашивает ресурс, расположенный по указанному URL;
  • POST - отправляет данные на сервер;
  • DELETE - удаляет указанный ресурс;
  • PATCH - вносит частичные изменения в указанный ресурс;
  • PUT - создает новый ресурс.

Подробнее об HTTP-методах

В EverGIS API ресурсом, к которому обращается тот или иной запрос, может быть любая сущность, которой оперирует серверная часть системы: пользователь, слой, таблица, карта, параметры стилей и др.

Методы POST, PATCH и PUT подразумевают передачу серверу данных, необходимых для выполнения операции (например, заполненная форма авторизации или описание стиля слоя), в теле запроса. В EverGIS API передача данных, как правило, осуществляется в формате JSON:

POST {host}/account/login
Content-Type: application/json
{
    "username": "username",
    "password": "password"
}

GET и DELETE лишь указывают на запрашиваемый или удаляемый ресурс в его URL. Также в URL могут быть указаны некоторые параметры запроса, к примеру, логин пользователя или системное имя слоя. К примеру, запрос GET {host}/layers/{layer_name} возвращает параметры и метаданные указанного слоя.

Работа с большинством запросов возможна только после авторизации, создания пользовательской сессии и получения JWT-токена, который “прикрепляется” к каждому запросу и позволяет серверу определять, от лица какого пользователя производится запрос. Подробнее об авторизации

Для работы с HTTP-запросами можно использовать: