Перейти к содержимому
RU
Ключ API
Обзор документации

Справочник API

Восстановление профиля канала YouTube и его последних видео по рукоятке, включая количество подписчиков, изображения каналов и детали видео.

Создать запрос

Введите ручку канала, например @youtube, а не его URL.

POSThttps://data.flashdata.dev/v1/queries/realtime
Python 3 · requests
python3 -m pip install requests
import json

import requests

api_key = "YOUR_API_KEY"
payload = {
    "source": "youtube_channel",
    "handle": "@jawed",
    "params": {
        "video_limit": 10,
    },
}

response = requests.post(
    "https://data.flashdata.dev/v1/queries/realtime",
    headers={"X-API-Key": api_key, "Accept": "application/json"},
    json=payload,
    timeout=120,
)
response.raise_for_status()
print(json.dumps(response.json(), ensure_ascii=False, indent=2))
Результаты ответа HTTPАутентификация X-API-Key

Параметры

Отправить source и handle на высшем уровне. Варианты источника принадлежат params. Факультативные поля можно опустить.

Тело запроса

sourcestring / Обязательно
Настройка на youtube_channel.
handlestring / Обязательно
Рукоятка канала, например, @jawed. Префикс @ является необязательным.
1 то 100 персонажиПо умолчанию: Не установлен
paramsobject / Необязательно
Settings для этого запроса.
По умолчанию: {}
callback_urlstring · nullable / Необязательно
Async и пакетные. Публичный HTTPS завершает URL на порте 443, вплоть до символов 2,048. Никаких учетных данных пользователя или фрагмента URL. Omit, используйте null или пустую строку без уведомления. В партии, установите это на каждый запрос, вне парамов.
По умолчанию: Не установлен

Выбор видео

params.video_limitinteger / Необязательно
Максимальное количество видео. Меньше может быть доступно.
1 то 100, целые числаПо умолчанию: 20

Ответ

Realtime возвращается status: done. Прочитайте исходный текст на results[0].videos; usage.credits Записывает обвинение.

Профиль канала находится в results[0]; его массив видео содержит последние видео. videoCount описывает канал и не является длиной возвращаемого массива.

Прочитайте результат

Сохраните успешный ответ JSON как response.json. Сохраните это как read-response.py и запустите python read-response.py. Он использует только стандартную библиотеку Python и не делает никаких новых запросов.

read-response.py
import json
from pathlib import Path

response = json.loads(Path("response.json").read_text(encoding="utf-8-sig"))
if response.get("status") not in ("done", "completed") or not isinstance(response.get("results"), list):
    raise SystemExit("Expected completed result JSON; inspect the response or job status.")
if not response["results"]:
    print("[]")
    raise SystemExit(0)
result = response["results"][0]

output = {
    "channelId": result.get("channelId"),
    "name": result.get("name"),
    "videos": [
        {"videoId": item.get("videoId"), "title": item.get("title")}
        for item in result.get("videos", [])
    ],
}
print(json.dumps(output, ensure_ascii=False, indent=2))

Отправляйте ручку на верхнем уровне с префиксом @ или без него. video_limit принадлежит к парам и принимает 1 к 100; по умолчанию к 20. Пример запрашивает 10.

Запрашиваемый лимит является максимальным, а не гарантией. Графики, изображения URLs и данные на видео могут быть null, когда они недоступны.

Все поля ответов
ПолеОписание
sourcestringЗапрошенный источник API.
statusstringДелается, когда запрос в режиме реального времени успешен.
created_atstringВремя создания ответов в формате ISO 8601.
usage.creditsnumberКредиты, взимаемые за запрос, исходя из вашего плана.
results[0].channelIdstringКанал ID.
results[0].channelHandlestringРучка канала.
results[0].namestringИмя канала.
results[0].descriptionstringОписание канала.
results[0].subscriberCountnumber · nullableПодписчик подсчитывает.
results[0].videoCountnumber · nullableПолное количество видео канала.
results[0].viewCountnumber · nullableПросмотр канала, когда он доступен.
results[0].avatarUrlstring · nullableКанал аватара URL.
results[0].bannerUrlstring · nullableКанал с баннером URL.
results[0].channelUrlstringКанал URL.
results[0].videosarrayПоследние видео, вплоть до записей video_limit.
results[0].videos[].videoIdstringВидео ID.
results[0].videos[].titlestringНазвание видео.
results[0].videos[].durationnumber · nullableПродолжительность в секундах.
results[0].videos[].viewCountnumber · nullableСчетчик просмотров.
results[0].videos[].uploadDatestring · nullableДата загрузки.
results[0].videos[].thumbnailstring · nullableВидео миниатюра URL.

Вышеприведенные поля описывают ответ JSON по умолчанию. JSON, простой текст и форматы Markdown.

Async возвращает одну квитанцию о приеме на работу; партия возвращает одну за одну работу ручка канала. Проверяйте статус каждой работы и извлекайте ее результаты, используя возвращенные ссылки.

Async и пакетный жизненный цикл

Подача возвращает квитанцию, а не результаты. Async создает одну работу; партия возвращает отдельную работу в queries[] на каждый принятый запрос. Отслеживайте и извлекайте каждую работу самостоятельно.

Представить data.flashdata.dev; читать статус работы и результаты api.flashdata.dev С тем же X-API-Key. Связанные базовые примеры API используют Python и cURL.

  1. 1. Сохранить работу IDs

    Держите поля запросов этого источника при переходе на Async. Для Batch поместите каждый запрос в массив запросов объекта JSON. Сохраните все возвращенные работы ID.

    Запрос и получение Async · Batch запросить

  2. 2. Проверьте статус

    GET https://api.flashdata.dev/v2/jobs/{jobId}

    pending / processing: Опрос с задержкой и уважением Retry-After когда присутствует. completed: Принесите результаты. failed: Проверить job.error.

    Читайте job.status, а не статус квитанции о представлении.

    Проверить статус: Python и cURL

    Статус работы API ссылка
  3. 3. Получить результаты

    GET https://api.flashdata.dev/v2/jobs/{jobId}/results

    После завершения аутентификации считывайте результат, а затем возьмите хранилище 302 URL без ключа API. Сохраните JSON в течение часов завершения 24.

    Результаты поиска: Python и cURL · Форматы ответов

    Результат скачивания ссылки API

Опросы и получение существующих результатов не потребляют кредиты запросов. Тайм-аут для голосования не отменяет работу: сохраняйте свой ID вместо того, чтобы подавать дубликат оплачиваемой работы. Коды ошибок и поведение retry.

Вебхуки завершения

Подписаться на запрос

Настройка callback_url на верхнем уровне асинхронного запроса, или Внутри каждого запроса в партии, снаружи params. Отдельного запроса на регистрацию webhook не требуется. Запросы Realtime не отправляют обратные вызовы.

Используйте общедоступный HTTPS URL на порту 443. FlashData POST - уведомление для каждой работы completed или failed; Событие содержит ссылки, а не сам результат.

Признать и проверить

Возвращение 2xx После того, как он принял это событие. Дублировать через delivery_id, Также посланный как X-Delivery-Id. Переадресации не выполняются.

Неудачные поставки с экспоненциальным обратным откатом, вплоть до 8 - полная версия и в большинстве 24 часов после завершения. Продолжайте опросы как запасной вариант.

Обратные звонки не подписаны. Подтвердить работу ID, исходный и терминальный статус через аутентифицированная конечная точка статуса перед обработкой уведомления. Поставка ID предназначена для дедупликации, а не для подтверждения подлинности.

Пример события web-cook и полей
Иллюстративное уведомление о завершении
{
  "delivery_id": "completion:job_example0001",
  "id": "job_example0001",
  "source": "youtube_channel",
  "status": "completed",
  "links": [
    {
      "rel": "self",
      "href": "https://api.flashdata.dev/v2/jobs/job_example0001",
      "method": "GET"
    },
    {
      "rel": "results",
      "href": "https://api.flashdata.dev/v2/jobs/job_example0001/results",
      "method": "GET"
    }
  ]
}
ПолеОписание
delivery_idstringСтабильный идентификатор доставки. Дублировать уведомления с использованием этого значения; он также отправляется в заголовке X-Delivery-Id.
idstringРаботать ID.
sourcestringЗапрошенный источник данных.
statusstringзавершены или не выполнены.
linksarrayСтатус и результат ссылки. Уведомления не включают контент результата или ключ API.
links[].relstringсебя или результаты.
links[].hrefstringАбсолютный менеджмент API URL; аутентифицируйтесь с помощью ключа API.
links[].methodstringGET.

Контракт на полный веб-хук и ограничения URL

Восстановление ошибок

Используйте ручку канала, а не видео ID или полный канал URL. Удаленный или недоступный канал может выйти из строя даже тогда, когда ручка проходит валидацию ввода. Недостающие изображения или подсчеты сами по себе не означают неудачу.

Для аутентификации, баланса, сбоев формата запроса и ограничения скорости используйте общую ссылку на ошибку. Тайм-аут может все еще создать работу; проверьте существующую работу перед повторным использованием.

Ошибки и коды состояния · Когда повторно · Ограничения по ставкам

Пошаговое руководство: Работа с каналом и его последние видео

Цены

ПланыСтавки использованияза 1 000 стандартных запросовПодпискиВключенные кредиты за расчетный период
Оплата по использованию0,50 $Без ежемесячной платыПополняйте по мере необходимости
Micro0,40 $49,00 $ / месяц1 000 кредиты ()50,00 $ из API использование, включая
Starter0,35 $199,00 $ / месяц4 000 кредиты ()200,00 $ из API использование, включая
Pro0,30 $499,00 $ / месяц10 000 кредиты ()500,00 $ из API использование, включая
Scale0,25 $999,00 $ / месяц20 000 кредиты ()1 000,00 $ из API использование, включая
Business0,20 $1 999,00 $ / месяц40 000 кредиты ()2 000,00 $ из API использование, включая

Один тариф аккаунта. Общие кредиты для трёх продуктов. Использование, покрытое включёнными кредитами, повторно не оплачивается.

Текущие цены и лимиты плана