Разработчикам
Описание и примеры запросов
REST / JSON
OpenAPI 3.0 (JSON)
Все методы работают по HTTPS, используют GET и заголовок Authorization: Bearer API_KEY. Ключ нельзя передавать через URL. Даты в часовом поясе сервера Asia/Almaty (+05:00). Значение all или отсутствие фильтра означает все разрешённые ключу записи.
| Метод | Эндпоинт | Назначение | Разрешение |
| GET | /api/external/companies.php | Список разрешённых компаний | allow_projects |
| GET | /api/external/locations.php | Список разрешённых активных ресторанов | allow_projects |
| GET | /api/external/projects.php | Компании с вложенными ресторанами (совместимость) | allow_projects |
| GET | /api/external/visits.php | Список визитов с пагинацией | allow_visits |
| GET | /api/external/visit.php?id=123 | Визит, анкета, ответы, комментарии | allow_details |
1. Компании и доступные точки
Получение справочников. company_id=13 ограничивает список точек выбранной компанией. По умолчанию locations.php возвращает активные точки; include_inactive=1 позволяет запросить также архивные, но только в пределах прав ключа. company_id = company.id, restaurant_id = rest.id, code = rest.restid.
Совместимый метод: projects.php (компании с вложенными точками).
2. Список визитов
company_id=13 или company_ids=13,4, restaurant_id=42 или restaurant_ids=42,58, date=2026-11-19 либо date_from=2026-11-01&date_to=2026-11-19, status=all|draft|final, page=1, limit=50 (до 100). Старые имена project_ids, location_ids также поддерживаются. Дата — завершения для final, начала для draft. Неудалённые визиты, по умолчанию оба статуса.
3. Один визит по ID
Возвращает блоки анкеты, вопросы и ответы, комментарии, оценку. URL PDF и фото/видео/аудио передаются только при отдельном разрешении «Медиа».
Пример JSON-ответа
{
"success": true,
"items": [{"id": 123, "guest": "Тайный гость #25", "project_id": 1,
"location_id": 10, "location_code": "R10", "status": "final", "score_percent": 92.0}],
"pagination": {"page": 1, "limit": 50, "total": 1, "total_pages": 1}
}
Ошибки: 400 — неверные параметры, 401 — неверный или просроченный ключ, 403 — нет разрешения, 404 — визит недоступен, 429 — лимит 600 запросов/час на ключ. Чужие проекты и точки не возвращаются. ФИО и телефон гостей не передаются.