Raster Tiles API
Сервис Raster Tiles API предоставляет растровые тайлы для двумерных карт.
Для работы с растровыми тайлами в зависимости от ваших задач вы можете использовать:
- публичный endpoint — для интеграции со сторонними библиотеками или собственной реализации;
- библиотеку RasterJS API — для отображения карты с минимальной настройкой.
Начало работы
1. Получите ключ доступа
-
Зарегистрируйтесь в личном кабинете Менеджер Платформы.
-
Создайте демо-ключ или купите подписку для доступа к API. Подробнее о стоимости сервиса см. в разделе Тарифы.
подсказкаЕсли у вас уже есть действующий API-ключ, полученный для RasterJS API, вы можете использовать его с Raster Tiles API до истечения срока действия подписки. Срок действия можно посмотреть в личном кабинете, на вкладке Главная.
Подробнее о работе с ключами и подписками см. в документации личного кабинета.
2. Работайте с API
Начните работать с растровыми тайлами, используя публичные endpoint-ы или библиотеку RasterJS API.
Использование публичного endpoint-а
При использовании сторонних библиотек укажите endpoint, по которому будут загружаться изображения тайлов:
https://tile{n}.maps.2gis.com/v2/tiles/{tileset}/{z}/{x}/{y}.png?key={key}
Здесь:
n— номер хоста. Может иметь значение от0до4. Вы можете использовать один хост, если у вас небольшой объём трафика, или распределять запросы между несколькими хостами самостоятельно.tileset— набор тайлов. Например,online_hdдля тайлов в высоком разрешении илиonline_sdдля тайлов в стандартном разрешении.z— масштаб карты. Чем больше число, тем подробнее карта.x,y— координаты тайла.key— ваш API-ключ.
Пример запроса:
https://tile0.maps.2gis.com/v2/tiles/online_hd/16/47851/20734.png?key=YOUR_KEY
Интеграция библиотеки RasterJS API
RasterJS API — это бесплатная JavaScript-библиотека для работы с двумерными картами 2ГИС. Содержит готовый набор инструментов для взаимодействия с картой, автоматически запрашивает растровые тайлы и отображает их на странице.
Чтобы использовать с библиотекой RasterJS API тайлы, предоставленные сервисом Raster Tiles API, сначала получите ключ доступа, затем подключите библиотеку к вашему проекту. Подробнее см. в инструкции Начало работы.
Пример использования
Статистика
При исчерпании лимитов сервис станет недоступен. Вы можете отслеживать расходование лимитов в подписке и статистику распределения запросов к сервису в личном кабинете. Подробнее об инструментах статистики см. в разделе Статистика.
Тарифы
-
Стоимость сервиса рассчитывается исходя из количества успешных запросов в месяц. Один запрос соответствует загрузке одного растрового тайла в формате PNG размером 256×256 пикселей.
-
Чтобы определить точное количество тайлов для отображения карты:
- Определите размер карты для отображения в пикселях (ширина и высота).
- Разделите ширину и высоту карты на 256 (размер одного тайла) и округлите полученные значения до ближайшего целого числа в большую сторону.
- Умножьте количество тайлов по горизонтали на количество тайлов по вертикали.
Полученное число — минимальное количество тайлов, необходимое для отображения видимой области карты. Рекомендуется добавить по одному тайлу с каждой стороны, чтобы обеспечить плавную прокрутку и масштабирование.
Например, чтобы отобразить область карты размером 800×600 пикселей, нужно минимум 12 тайлов (4 по горизонтали и 3 по вертикали), а оптимально — 30 тайлов (6 по горизонтали и 5 по вертикали).
-
Безлимитный доступ к библиотеке RasterJS API предоставляется бесплатно.
-
Актуальную стоимость и лимиты см. в разделе Тарифы.
Варианты размещения
- Облако: Raster Tiles API доступен через публичные endpoint-ы 2ГИС.
- On-Premise: для получения растровых тайлов установите Tiles API в составе API-платформы 2ГИС в закрытом контуре. Подробнее см. в разделе API-платформа для сервера.
Помощь
-
Если у вас возникли вопросы при работе с API, задайте их AI-ассистенту (в правом нижнем углу cайта), воспользуйтесь поиском по документации или отправьте электронное письмо на api@2gis.ru.
-
Если вы хотите обсудить возможности API или его интеграцию с вашим продуктом, обратитесь к менеджеру.