Acuity Scheduling

Acuity Scheduling — это интеграция API для работы с системой онлайн-записи с использованием управляемой OAuth-аутентификации. Решение позволяет управлять встречами, календарями, клиентами и доступностью.

Этот инструмент подходит в случаях, когда необходимо создавать, переносить или отменять записи, проверять доступные слоты или управлять клиентской базой и календарями.

Возможности

• Управление встречами и бронированием
• Работа с календарями и доступностью
• Управление клиентами
• Интеграция через API с OAuth-аутентификацией

Быстрый старт

Пример запроса для получения списка встреч:

import urllib.request, os, json

req = urllib.request.Request('https://gateway.maton.ai/acuity-scheduling/api/v1/appointments?max=10')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')

print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))

Базовый URL:

https://gateway.maton.ai/acuity-scheduling/{native-api-path}

Замените {native-api-path} на соответствующий путь API Acuity Scheduling. :

Аутентификация

Все запросы требуют передачи API-ключа Maton в заголовке:

Authorization: Bearer $MATON_API_KEY

Перед началом необходимо задать переменную окружения:

export MATON_API_KEY="YOUR_API_KEY"

Чтобы получить ключ, зарегистрируйтесь на платформе maton.ai и скопируйте его в настройках аккаунта. :

Управление подключениями

Для работы с OAuth-подключениями используется отдельный сервис управления.

Получение списка активных подключений:

req = urllib.request.Request('https://ctrl.maton.ai/connections?app=acuity-scheduling&status=ACTIVE')

Создание нового подключения:

data = json.dumps({'app': 'acuity-scheduling'}).encode()

После создания необходимо открыть полученный URL в браузере и завершить OAuth-авторизацию.

Работа с встречами

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

Метод:

GET /acuity-scheduling/api/v1/appointments

Поддерживаемые параметры:

• max — максимальное количество результатов
• minDate / maxDate — фильтрация по дате
• calendarID — фильтр по календарю
• appointmentTypeID — тип встречи
• email, firstName, lastName — фильтры по клиенту
• canceled — включать отменённые встречи

Создание встречи

POST /acuity-scheduling/api/v1/appointments

Обязательные поля:

• datetime — дата и время
• appointmentTypeID — тип встречи
• firstName, lastName — имя клиента
• email — email клиента

Дополнительно можно указать телефон, таймзону, заметки и другие параметры.

Обновление и отмена

• PUT /appointments/{id} — обновление данных встречи
• PUT /appointments/{id}/cancel — отмена встречи

После отмены запись возвращается с флагом canceled: true. :

Дополнительно

Если у вас несколько подключений, можно указать конкретное через заголовок:

Maton-Connection: 

Если параметр не задан, используется подключение по умолчанию.