API и ключи доступа
Интеграции, разрешения ключей, каталог методов и безопасные повторы операций.
Создайте ключ в кабинете
API предоставляет операции аккаунта, тарифа, партнёрской программы, Instagram, автоответов, исследований, лаборатории и публикаций согласно доступному каталогу. Для обычных операций нужны API-доступ и соответствующие функции тарифа.
- Откройте раздел API, задайте имя, срок действия и только необходимые разрешения ключа.
- Сразу сохраните показанный секрет: полностью он отображается только при создании.
- Передавайте ключ как Authorization: Bearer через свою интеграцию. Не помещайте его в публичный код.
- В кабинете проверяйте статус и последнее использование, редактируйте разрешения или отзывайте ключ.
Каталог — точный контракт
Базовый путь — /api/v1. В каталоге и OpenAPI указаны методы, поля, разрешения и требования к Idempotency-Key. Создание ключей и редактирование их разрешений выполняются в кабинете, а не через публичный API. Новые разрешения не добавляются к старому ключу автоматически.
Обычные запросы расходуют api_requests, включая повторы; предметные квоты учитываются отдельно. Операции обслуживания, проверки состояния, паузы и отмены, отмеченные в каталоге как обслуживание, освобождены от этой квоты и тарифного допуска, но сохраняют проверку авторизации, прав и частоты запросов.
Повторы и фоновые операции
Когда метод требует Idempotency-Key, создайте UUID для новой операции, а при повторе используйте тот же UUID и тело. Изменённое тело может дать 409. Проверяйте контракт конкретного метода: у старых методов заголовок может быть необязательным.
Ответ 202 и statusUrl означают фоновую обработку. Опросите statusUrl; он возвращает состояние и прогресс, а не полный результат. UNKNOWN означает неопределённый итог: проверьте операцию и созданный ресурс, прежде чем повторять с новым UUID.
Повторы, ограничения и восстановление
Письма входа ограничены пятью на адрес и двадцатью на доверенный IP за 15 минут. Ответ не раскрывает существование аккаунта. Если письмо не пришло, проверьте спам и повторите позже. При CSRF_INVALID обновите страницу и повторите действие; не меняйте ключ операции после неопределённого результата.
Нужна помощь? Передайте поддержке код ошибки, время и идентификатор операции. Не передавайте API-ключи и токены.