API: как пользоваться? Пошаговая инструкция
Тестирование API в Postman
Для теста используйте коллекцию:
Postman-коллекция для API
Инструкция по использованию:
Перейдите по ссылке на коллекцию:
Postman
Импортируйте коллекцию в Postman.
Используйте ваш токен в разделе:
API → Токены доступа
Вставьте токен в Postman
Post create
Get show
5. Для теста вы можете ввести любой демо-аккаунт в разделе Dashboard, чтобы сервис не списывал с вас проверки.
https://trendhero.io/app/dashboard — Demo reports (в самом низу страницы)
Для начала вам нужно запросить/создать отчёт (POST create).
Обратите внимание, что нужно использовать следующую ссылку:
https://api.trendhero.io/api/public/v1/reports?username=davidrobsonyoga
После знака = указываете логин нужного блогера.
После того как вы отправите запрос, в разделе Body будет отображаться информация по блогеру (частично, и данные будут периодически обновляться по мере получения новой информации).
Чтобы проверить статус отчёта, в поиске введите status.
Вы получите два результата — вам нужно обратить внимание на первый.
Как на скриншоте:
status — collecting
Также возможны следующие статусы:
recollecting — сервис повторно формирует отчёт
ready — отчёт готов
impossible — аккаунт закрыт или сервис не может сформировать отчёт
После того как вы запросили отчёт в разделе Post create, обязательно сохраните значение поля "pk".
Это и есть account_pk — уникальный идентификатор (Instagram ID) данного аккаунта.
Наш сервис идентифицирует аккаунт именно по этому параметру ( pk / account_pk).
Это важно, чтобы при получении callback вы точно понимали, по какому аккаунту пришло уведомление.
P.S. Если вы отправили запрос и получили сообщение:
"error": "У вас самая свежая версия"
Это означает, что вы уже запрашивали отчет ранее.
В этом случае просто перейдите в раздел GET Show, чтобы получить готовый отчет.
Что происходит после отправки запроса на получение отчета?
После того как вы отправили запрос на получение отчета, сервису потребуется время для его формирования.
Скорость зависит от размера аккаунта и актуальности данных:
Если отчёт уже есть в базе, он сформируется моментально.
Если аккаунт ранее не проверялся или проверялся давно, и у него большая аудитория (например, миллион подписчиков), процесс анализа может занять от 2 до 4 часов.
Для небольших аккаунтов (до 10 000 подписчиков) отчёт формируется в течение 30–60 минут.
Как узнать, что отчёт готов?
Когда отчёт будет сформирован, сервис отправит вам callback.
Чтобы получать callback-уведомления, вам нужно в разделе
API - Токены доступа Webhook url
указать URL вашего сервера — адрес, по которому вы хотите получать уведомления.
Пример Call back, который вы получите от сервиса:
{"report_type": "overall_report",
"notification_type": "report_ready",
"account_pk": 209749858,
"version": "1601367830"}
Пояснение:
account_pk — это уникальный идентификатор аккаунта в Instagram (Instagram ID).
Раздел Get Show
Чтобы получить данные отчета, используйте следующую ссылку:
https://api.trendhero.io/api/public/v1/reports/davidrobsonyoga
Вместо davidrobsonyoga укажите логин нужного блогера после последнего /
Вот так выглядят данные по отчетам.
Количество строк зависит от самого аккаунта и того, как давно он был в базе.
Если аккаунт крупный и добавлен давно, данных может быть много — до 20 000 строк.
Кейсы и типичные ошибки:
Раздел Get Show
"error": "Wrong token"
Вы неправильно ввели ваш токен.
Перейдите в раздел API – Токены доступа,
проверьте, правильно ли вы скопировали и вставили токен.
В разделе Body слишком мало информации (например, только до 1000 строк).
Статус отчета — preview.
Вы не запрашивали этот отчет через раздел Post create.
Откройте раздел Post create и сначала отправьте запрос на генерацию отчета для нужного аккаунта.
Для теста используйте коллекцию:
Postman-коллекция для API
Инструкция по использованию:
Перейдите по ссылке на коллекцию:
Postman
Импортируйте коллекцию в Postman.
Используйте ваш токен в разделе:
API → Токены доступа
Вставьте токен в Postman
Post create
Get show
5. Для теста вы можете ввести любой демо-аккаунт в разделе Dashboard, чтобы сервис не списывал с вас проверки. https://trendhero.io/app/dashboard — Demo reports (в самом низу страницы)
Для начала вам нужно запросить/создать отчёт (POST create).
Обратите внимание, что нужно использовать следующую ссылку:
https://api.trendhero.io/api/public/v1/reports?username=davidrobsonyoga
После знака = указываете логин нужного блогера.
После того как вы отправите запрос, в разделе Body будет отображаться информация по блогеру (частично, и данные будут периодически обновляться по мере получения новой информации).
Чтобы проверить статус отчёта, в поиске введите status.
Вы получите два результата — вам нужно обратить внимание на первый.
Как на скриншоте:
status — collecting
Также возможны следующие статусы:
recollecting — сервис повторно формирует отчёт
ready — отчёт готов
impossible — аккаунт закрыт или сервис не может сформировать отчёт
После того как вы запросили отчёт в разделе Post create, обязательно сохраните значение поля "pk".
Это и есть account_pk — уникальный идентификатор (Instagram ID) данного аккаунта.
Наш сервис идентифицирует аккаунт именно по этому параметру ( pk / account_pk).
Это важно, чтобы при получении callback вы точно понимали, по какому аккаунту пришло уведомление.
"account_pk": 72018706099 / "pk": 72018706099 = "username": "model.gen.mgmt"P.S. Если вы отправили запрос и получили сообщение:
"error": "У вас самая свежая версия"
Это означает, что вы уже запрашивали отчет ранее.
В этом случае просто перейдите в раздел GET Show, чтобы получить готовый отчет.
Что происходит после отправки запроса на получение отчета?
После того как вы отправили запрос на получение отчета, сервису потребуется время для его формирования.
Скорость зависит от размера аккаунта и актуальности данных:
Если отчёт уже есть в базе, он сформируется моментально.
Если аккаунт ранее не проверялся или проверялся давно, и у него большая аудитория (например, миллион подписчиков), процесс анализа может занять от 2 до 4 часов.
Для небольших аккаунтов (до 10 000 подписчиков) отчёт формируется в течение 30–60 минут.
Как узнать, что отчёт готов?
Когда отчёт будет сформирован, сервис отправит вам callback.
Чтобы получать callback-уведомления, вам нужно в разделе
API - Токены доступа Webhook url
указать URL вашего сервера — адрес, по которому вы хотите получать уведомления.
Пример Call back, который вы получите от сервиса:
{"report_type": "overall_report",
"notification_type": "report_ready",
"account_pk": 209749858,
"version": "1601367830"}
Пояснение:
account_pk — это уникальный идентификатор аккаунта в Instagram (Instagram ID).
Раздел Get Show
Чтобы получить данные отчета, используйте следующую ссылку:
https://api.trendhero.io/api/public/v1/reports/davidrobsonyoga
Вместо davidrobsonyoga укажите логин нужного блогера после последнего /
Вот так выглядят данные по отчетам.
Количество строк зависит от самого аккаунта и того, как давно он был в базе.
Если аккаунт крупный и добавлен давно, данных может быть много — до 20 000 строк.
Кейсы и типичные ошибки:
Раздел Get Show
"error": "Wrong token"
"error": "Wrong token"Вы неправильно ввели ваш токен.
Перейдите в раздел API – Токены доступа,
проверьте, правильно ли вы скопировали и вставили токен.
В разделе Body слишком мало информации (например, только до 1000 строк).
Статус отчета — preview.
Вы не запрашивали этот отчет через раздел Post create.
Откройте раздел Post create и сначала отправьте запрос на генерацию отчета для нужного аккаунта.
Последнее изменение: 25/04/2025
Спасибо!