Обзор API карт 2ГИС

Используйте API карт 2ГИС для интеграции векторных и растровых карт в ваши веб-приложения, мобильные приложения и сайты.

MapGL JS API позволяет добавить детальную трёхмерную карту 2ГИС в ваше веб-приложение или на сайт и показать на ней ваши данные от маркеров и интерактивных 3D-моделей до тепловых карт. Эта JavaScript-библиотека предоставляет доступ к векторным тайлам карты и инструментам для работы с ними. Выбирайте векторную карту, если хотите использовать иммерсивные возможности или настраивать внешний вид карты под ваши задачи (например, фирменный стиль).

Попробуйте переместить центр карты ниже и изменить масштаб и наклон, чтобы оценить иммерсивный графический режим MapGL JS API:

Чтобы отобразить двумерную растровую карту, используйте Raster Tiles API. Вы можете получать растровые тайлы как напрямую через запрос к API, так и с помощью JavaScript-библиотеки RasterJS API. Используйте растровую карту, если хотите получить точную интерактивную карту с минимальными затратами ресурсов устройства.

Пример интеграции растровой карты с помощью RasterJS API:

Static API позволяет получить актуальное статичное изображение карты в нужной точке и с нужным уровнем масштабирования. Используйте статичные изображения для добавления снимков карты в документы, письма, сообщения и другие материалы, где не требуется интерактивность.

Попробуйте изменить размер изображения, координаты центра карты и её масштаб, чтобы получить нужный фрагмент карты и готовый запрос к Static API:

Дополнительные инструменты:

• Редактор стилей для настройки внешнего вида векторных карт в зависимости от ваших целей или фирменного стиля вашего проекта.
• FloorsJS для создания удобного виджета навигации по этажам внутри зданий.

FAQ

Как начать работать с API карт?

Чтобы работать с API, получите ключ доступа:

1. Зарегистрируйтесь в личном кабинете Менеджер Платформы.
2. Создайте демо-ключ или купите подписку для доступа к API.
3. Изучите пример запросов и ответов в документации к нужному API.

Как рассчитывается стоимость использования API?

• Стоимость использования MapGL JS API фиксирована на выбранный период действия подписки и не зависит от количества запросов к API в течение этого периода. Для получения тайлов библиотека использует Tiles API, который включён в стоимость использования MapGL JS API.
• Стоимость использования Raster Tiles API и Static API рассчитывается по количеству запросов к API. Подробнее о способе расчёта см. в разделе Тарифы на странице каждого API.
• Редактор стилей и FloorsJS предоставляются бесплатно.

Можно ли использовать API карт бесплатно?

Вы можете оформить демо-ключ доступа для тестирования API карт на один месяц с ограниченным числом запросов.

Как отслеживать фактическое использование API-ресурсов?

Вы можете отслеживать прогресс расходования лимитов по сервисам и статистику распределения запросов в личном кабинете Менеджер Платформы. Подробнее см. в разделе Статистика.

Как контролировать потребление API-ресурсов?

Чтобы избежать преждевременного исчерпания лимитов, вы можете ограничить использование API-ресурсов вашими приложениями. В личном кабинете Менеджер Платформы вы можете:

• Установить лимиты на запросы к конкретным сервисам по всем API-ключам в подписке или по отдельным ключам. При превышении лимитов использование продукта ограничится: запросы к API будут возвращать ошибку.
• Настроить отправку уведомлений при приближении к лимитам.

Подробнее см. в разделе Управление ключами доступа.

Что такое тайлы?

Тайл — это квадратное изображение, соответствующее участку карты. Использование тайлов позволяет экономить ресурсы устройств и отображать только видимую часть карты, подгружая необходимые фрагменты при перемещении по карте или при изменении масштаба карты.

Чем растровые тайлы отличаются от векторных?

Растровые тайлы — это изображения фрагментов карты в формате PNG, которые отрисовываются на стороне сервера и отправляются вашему устройству в готовом виде. Отображение растровой карты требует меньше ресурсов устройства, но не позволяет гибко настраивать внешний вид карты и её поведение. Чтобы работать с растровой картой, используйте Raster Tiles API или Static API.

Векторные тайлы — это данные, которые ваше устройство получает и отрисовывает самостоятельно, согласно заданному стилю (правилу отрисовки). Векторные тайлы позволяют изменять внешний вид карты в реальном времени, создавать интерактивные объекты и анимации, а также обеспечивают более плавное масштабирование и перемещение по карте. Для работы с векторной картой используйте MapGL JS API.

Можно ли для работы с тайлами использовать сторонние библиотеки?

• Векторные тайлы: вы можете использовать только библиотеку MapGL JS API.
• Растровые тайлы: рекомендуется использовать библиотеку RasterJS API. Вы также можете использовать сторонние библиотеки, но их совместимость с растровыми картами 2ГИС не гарантируется и в любой момент может быть нарушена без предупреждения.

Подробнее об условиях см. в Соглашении об использовании сервисов 2ГИС.

Можно ли напрямую получить доступ к тайлам карты?

Чтобы получить векторные тайлы напрямую для интеграции в ГИС-систему, которая не поддерживает использование MapGL JS API, вы можете установить API-платформу 2ГИС в закрытом контуре (On-Premise) и экспортировать векторные тайлы в формате Mapbox Vector Tiles (MVT). Растровые тайлы вы можете получить напрямую через Raster Tiles API и Static API.

Какие есть технические ограничения?

MapGL JS API оптимизирован для работы в современных веб-браузерах, полный список браузеров и их версий см. в разделе Поддержка браузеров. Если вы планируете добавлять 3D-объекты на карту, ознакомьтесь с Требованиями и рекомендациями для 3D-моделей.

Как можно настроить внешний вид карты?

При работе с векторными картами 2ГИС через MapGL JS API вы можете:

• Настроить центр карты, масштаб, элементы управления картой, графический режим, обработку событий и т. д.
• Изменить внешний вид карты (цвета, освещение, уровень детализации, видимость объектов и подписей и многое другое) с помощью Редактора стилей.
• Добавить на карту свои данные: объекты разной сложности (иконки, маркеры с анимацией, 3D-модели) или источники векторных и растровых геоданных.

При работе с растровыми картами 2ГИС через Raster Tiles API и Static API вы можете:

• Настроить центр карты, масштаб, элементы управления картой, обработку событий и т. д.
• Добавить на карту свои данные: объекты (маркеры, геометрические фигуры, подписи) или геоданные в формате GeoJSON.

Можно ли установить сервисы карт в собственной инфраструктуре?

Да, вы можете установить API-платформу 2ГИС в закрытом контуре. Подробнее см. в разделе On-Premise.

Нет ответа на мой вопрос

Воспользуйтесь поиском по документации или отправьте электронное письмо на api@2gis.ru.