TPS Gateway
Документация интеграционного API.
API TPS Gate для партнёров сервиса
В документе описан API TPS Gate.
API позволяет встроить возможности партнерского интерфейса TPS Gate в вашу собственную систему. Основными возможностями являются:
- Выгрузка информации о парковках и шлагбаумах.
- Открытие шлагбаумов.
Как получить авторизованный доступ к парковке
Для авторизации доступа на парковку мы используем телефон клиента, который вы присылаете нам с запросом на открытие или получение парковки. Если телефон клиента существует в базе данных автопарка, то мы можем предоставить водителю доступ к парковке, в противном случае мы отправим вам сообщение "Доступ запрещен".
Вы можете отправить нам телефон в следующем формате:
- XXXXX - последние реальные пять цифр номера телефона, вы отправляете нам часть номера телефона, а не полный реальный номер.
Content-Type
Все ваши запросы должны быть отправлены как HTTP с JSON. Пожалуйста, проверьте ваши заголовки и установите заголовок 'Content-Type' = 'application/json'.
Типы Объектов
В нашем API используются следующие типы объектов для представления различных точек доступа или преград. Ниже приведен список этих типов вместе с их описанием:
| Тип объекта | Описание |
|---|---|
| gate | Шлагбаум |
| door | Подъездная дверь |
| barrier | Ворота |
| wicket | Калитка |
| ip_intercom | IP Домофон |
| intercom | Домофон |
| other | Иное |
ip_intercom -- домофон с сетевым доступом, intercom -- домофон с клавиатурой и кодовым доступом.
Эти типы объектов помогают указать, с каким видом точки доступа вы взаимодействуете при выполнении API-запросов. Пожалуйста, используйте соответствующий тип для получения корректных ответов.
Authentication
- API Key: api_key
Secret key (в примере тестовый ключ)
| Security Scheme Type: | apiKey |
|---|---|
| Header parameter name: | SecretKey |