Введение
GraphQL API ParrotPoster позволяет автоматизировать публикацию постов в социальные сети, управлять постами и получать список подключённых аккаунтов из ваших скриптов, сайтов и сервисов.
Общие сведения
API построено на GraphQL: вы запрашиваете только те поля, которые вам нужны, и получаете их одним запросом. Веб-приложение ParrotPoster и плагины для WordPress и 1C-Битрикс работают через тот же API.
Адрес API:
https://parrotposter.com/api/graphql
- POST-запрос выполняет запросы (
query) и мутации (mutation). Тело — JSON с полемquery(и при необходимостиvariables). Так API нужно вызывать из кода. - GET-запрос открывает в браузере интерактивную среду GraphiQL (playground): в ней видна полная схема и можно пробовать запросы вручную.
Что можно делать через API
- получать список подключённых аккаунтов и их состояние;
- создавать, получать, обновлять и удалять посты;
- публиковать сразу, по расписанию или сохранять как черновик;
- читать результаты публикации и статистику вовлечённости.
Подключать аккаунты соцсетей и настраивать автоматизацию нужно в личном кабинете: через API это не делается.
Как начать
- В кабинете откройте Настройки → API-токены и создайте токен (подробнее).
- Передавайте токен в заголовке
Authorization: Bearer <токен>. - Выполните первый запрос — см. Начало работы.
Ограничения
- Публикация и изменение постов требуют активного тарифа, а количество постов и аккаунтов ограничено вашим тарифом.
- На запросы по API-токену действует лимит частоты: по умолчанию 600 запросов в минуту на один токен. При превышении сервер отвечает HTTP-статусом
429. Подробнее — в разделе Ошибки.
Совместимость
Схема API расширяется новыми полями и методами. Устаревшие поля помечаются директивой @deprecated в схеме (её видно в playground), поэтому запрашивайте только нужные поля и не полагайтесь на порядок полей в ответе.
Содержание
- Начало работы — первый запрос за 5 минут
- Аутентификация — API-токены и мутация
login - Аккаунты соцсетей —
listSocialAccounts - Посты — обзор, структура Post, получение и список, создание, обновление, удаление
- Ошибки — формат ошибок, коды, лимиты
