Документация API

У сервиса PassLite есть API для интеграции с внешними системами. Он позволяет пользователям с ролью "Заказчик" автоматизировать создание пропусков.

Авторизация

Все запросы выполняются по протоколу HTTPS.

API-ключ необходимо передавать в HTTP-заголовке:

Authorization: Bearer YOUR_API_KEY

---

Создание пропуска

Метод	POST
URL	https://passlite.ru/api/createPass.php

---

Параметры запроса

Параметр	Обязательный	Описание
passType	Да	Тип пропуска. single — одноразовый many — многоразовый
passName	Да	Название пропуска. От 3 до 100 символов.
visitorType	Да	Тип посетителя. person — посетитель car — автомобиль
personInfo	Для посетителей	Информация о посетителе. От 3 до 200 символов.
carNumber	Для автомобилей	Номер автомобиля.
carType	Для автомобилей	Тип автомобиля: carpassenger — легковой cartruck — грузовой
passDate	Для одноразового пропуска	Планируемая дата посещения. Формат: YYYY-MM-DD
passDateStart	Для многоразового пропуска	Дата начала действия. Формат: YYYY-MM-DD
passDateEnd	Для многоразового пропуска	Дата окончания действия. Формат: YYYY-MM-DD

---

Пример запроса

POST /api/createPass.php HTTP/1.1
Host: passlite.ru
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
    "passType":"single",
    "passName":"Посетитель",
    "visitorType":"person",
    "personInfo":"Иванов Иван Иванович",
    "passDate":"2025-03-15"
}

---

Пример автомобильного пропуска

{
    "passType":"single",
    "passName":"Поставка товара",
    "visitorType":"car",
    "carNumber":"А123ВС777",
    "carType":"cartruck",
    "passDate":"2025-03-15"
}

---

Пример многоразового пропуска

{
    "passType":"many",
    "passName":"Сервисная организация",
    "visitorType":"person",
    "personInfo":"ООО Сервис",
    "passDateStart":"2025-03-15",
    "passDateEnd":"2025-03-25"
}

---

Успешный ответ

{
    "success": true,
    "passID": "1234567890abcdf", //Идентификатор созданного пропуска
    "passUrl": "https://passlite.ru/pass.php?id=1234567890abcdf" //Публичная ссылка на пропуск
}

---

Ответ при ошибке

{
    "success": false,
    "errorCode": "INVALID_API_KEY", //код ошибки
    "errorDesc": "Неверный API ключ." //Описание ошибки
}

Получение статуса пропуска

Метод	POST
URL	https://passlite.ru/api/getStatusPass.php

---

Параметры запроса

Параметр	Обязательный	Описание
passID	Да	Идентификатор пропуска

---

Пример запроса

{
    "passID":"7d05c............."
}

---

Успешный ответ

{
    "success": true,
    "passID": "7d05c.............", //Идентификатор пропуска
    "status": "approved" //Статус пропуска
}

---

Ответ при ошибке

{
    "success": false,
    "errorCode": "PASS_NOT_FOUND", //код ошибки
    "errorDesc": "Пропуск не найден." //Описание ошибки
}

---

Статусы пропусков

• new - новый пропуск. Этот статус пропуск получает сразу после создания.
• approved - пропуск согласован. Ожидается визит посетителя.
• entered - посетитель на территории.
• closed - пропуск закрыт. Посетитель покинул территорию.
• canceled - пропуск отменен.
• rejected - пропуск отклонен

Уведомления об изменении статуса пропуска

Уведомления позволяют автоматически отправлять статусы пропусков вашей внешней системе.

При изменении статуса пропуска, на URL, который вы указали в настройках, придет уведомление об изменении статуса пропуска.

---

Пример уведомления

{
    "passID": "7d05c.............", //Идентификатор пропуска
    "status": "closed" //Статус пропуска
}

---

Настройка уведомлений

В личном кабинете нажмите на иконку пользователя в правом верхнем углу и выберите пункт Настройки

В появившемся окне перейдите на вкладку API

Включите уведомления и введите URL для приема уведомлений. Сохраните настройки.