API-платформа

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

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

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

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

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

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

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

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

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

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

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

• Векторные тайлы: для доступа к Map Tiles 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.