API для разработчиков
Сторонние приложения работают с данными бизнеса через публичный API — Platform API v1: читают профиль, каталог, меню, заказы, отчёты, а с разрешения владельца — создают заказы. Эта статья — о том, где документация, как приложение получает доступ и кто им управляет.
Условия
При использовании API в коммерческих целях с компанией заключается индивидуальный договор или согласуются отдельные условия. Если вы планируете интеграцию, напишите в этот чат — специалист расскажет условия и зарегистрирует ваше приложение.
Документация
Документация открыта без входа и без ключа:
| Что | Paloma365 | PalomaPOS |
|---|---|---|
| Документация для людей | https://alfaposapi.paloma365.com/platform/v1/docs | https://alfaposapi.palomapos.com/platform/v1/docs |
| Руководство по интеграции (Markdown) | https://alfaposapi.paloma365.com/platform/v1/guide.md | https://alfaposapi.palomapos.com/platform/v1/guide.md |
| Описание API в формате OpenAPI | https://alfaposapi.paloma365.com/platform/v1/openapi.json | https://alfaposapi.palomapos.com/platform/v1/openapi.json |
| Точка входа для AI-инструментов | https://alfaposapi.paloma365.com/platform/llms.txt | https://alfaposapi.palomapos.com/platform/llms.txt |
Если интеграцию пишет AI-помощник разработчика, дайте ему ссылку на llms.txt — там собраны ссылки на всё остальное.
API включается на каждом рынке отдельно. Пока он не включён, документация уже открыта, а запросы к данным отвечают ошибкой 404.
Как приложение получает доступ
- Регистрация приложения. Разработчик пишет в этот чат; мы регистрируем приложение и выдаём ему идентификатор и секрет. Если интеграция нужна только вашему собственному бизнесу, регистрация не нужна — см. «Своя интеграция: ключ из дашборда».
- Согласие владельца. Приложение открывает экран подтверждения на нашем сервере. Владелец аккаунта видит, какое приложение просит доступ и что оно сможет делать, и нажимает Разрешить. Сотрудник и специалист поддержки дать согласие не могут.
- Работа. Приложение получает доступ только к данным этого аккаунта и только в пределах того, на что согласился владелец. Доступ, выданный одним аккаунтом, не открывает данные другого: для каждого заведения согласие даётся отдельно.
Своя интеграция: ключ из дашборда
Владелец аккаунта может сам создать ключ для своих скриптов и сервисов — без регистрации разработчика и без экрана подтверждения: «Подключённые приложения» → Создать интеграцию.
Это тот же Platform API v1: те же адреса, те же права доступа и тот же заголовок Authorization: Bearer. Отличается только то, откуда берётся токен:
- ключ (начинается с
ppik_) показывается владельцу один раз при создании; - он открывает данные только этого аккаунта и только в пределах отмеченных прав;
- срока действия у него нет — он работает, пока владелец не удалит интеграцию на той же странице;
- обновлять его, как токен приложения, не нужно.
Проверить ключ можно одним запросом (для PalomaPOS — адрес alfaposapi.palomapos.com):
curl https://alfaposapi.paloma365.com/platform/v1/me -H "Authorization: Bearer <ключ>"Храните ключ как пароль. Если он мог попасть к посторонним, удалите интеграцию и создайте новую.
Как посмотреть и отозвать доступ
Все подключённые приложения и свои интеграции видны в разделе «Подключённые приложения»: что каждое может делать и когда последний раз обращалось к данным. Там же владелец отзывает доступ или удаляет интеграцию — доступ пропадает сразу.
Что смотреть по темам
- Готовые интеграции (доставка, маркетплейсы, Telegram, Bitrix24) — их подключают переключателем, без программирования: «Интеграции».
- MCP-коннектор — отдельный способ подключить AI-помощника к данным аккаунта: «MCP-коннектор».