Введение

Получить ключ API

Что такое Sofia API?

Sofia API даёт вашему коду доступ к аккаунту Sofia: заведениям ваших Workspace, их подключённым сетям, медиатеке, публикациям и статистике. Это REST API по HTTPS. Запросы и ответы передаются в JSON, а все endpoint находятся под одним базовым URL.

text
https://api.sofia-post.com/api/v1

Что умеет API?

  • Публиковать: сразу, в заданное время или как черновик, в одну или несколько сетей одновременно.
  • Проверять перед публикацией: пробный запуск (dry run) показывает, примет ли каждая сеть публикацию, и ничего не записывает.
  • Управлять медиа: загрузите файл или импортируйте его по URL в медиатеку заведения.
  • Следить за публикациями: читайте состояние каждой сети, постоянную ссылку или причину ошибки. Сообщить об этом может и подписанный webhook.
  • Читать статистику: последние данные, собранные Sofia по каждому подключённому аккаунту.
  • Подключать сети: создайте размещённую ссылку, по которой владелец подключит недостающую сеть.

Для кого это?

Если вы автоматизируете собственный Workspace, достаточно личного ключа: создайте его в разделе Настройки › API и передавайте как Bearer-токен. Для SaaS-продукта, который действует от имени пользователей в их Workspace, зарегистрируйте OAuth-клиент: каждый человек авторизует ваше приложение в выбранном им Workspace.

Дальнейшие шаги