SmartShell API позволяет интегрировать SmartShell с внешними сервисами и приложениями: получать данные из системы и выполнять определённые действия через программные запросы.
API построен на GraphQL. В отличие от классического REST API, GraphQL позволяет в одном запросе указать, какие именно данные необходимо получить. Ответ возвращается в формате JSON.
Начало работы
Для работы с API потребуется API-токен. Создать его можно в личном кабинете владельца, перейдя в карточку клуба.
После получения токена его необходимо использовать при отправке запросов к API. Не передавайте токен третьим лицам и не публикуйте его в открытом доступе.
Что можно делать через API
API предоставляет методы для работы с основными объектами SmartShell. Например:
- получать информацию о клиентах клуба;
- получать информацию об оплатах и продажах;
- получать данные о хостах, товарах и услугах;
- создавать и изменять бронирования;
- создавать платежи;
- управлять депозитом;
- выполнять другие доступные операции.
Список доступных методов и их параметры приведён в документации API.
Query и Mutation
В SmartShell API используются два основных типа GraphQL-запросов:
Query — получение данных. Аналог GET-запроса в REST API.
Например, можно запросить бронирования определённых хостов и получить только их идентификаторы.
Mutation — изменение данных или выполнение действия. Например, с помощью Mutation можно создать хост, бронирование или платёж.
Документация
В документации подробно описаны доступные методы, параметры запросов, объекты и возможные ошибки, вы можете посмотреть ее здесь.
Если вы впервые работаете с GraphQL, рекомендуем начать с раздела «Начало работы», а затем перейти к описанию необходимых методов.