Перейти к содержимому

Capzy Data API. Выберите источник.

Найдите эндпоинт поддерживаемого сайта, передайте его параметры и получите JSON. Изучите справочник здесь, затем запускайте и проверяйте запросы в песочнице панели управления.

Поиск Amazon в двух словах

Источник + действиеGET /v1/amazon/search
Запросwireless earbuds
Поле ответаorganic_results · названия, цены, ASIN

Иллюстративный пример

Найдите нужный источник

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

Все источники (83)

Ваш первый запрос к Data API

Этот пример для Amazon использует GET-эндпоинт конкретного источника. HTTP 200 возвращает данные источника; HTTP 202 возвращает статус ожидания и jobId. Прежде чем отправлять новый запрос, проверьте ожидающие задания на странице «Запуски» в панели Data API.

  1. Создайте ключ Data API

    Откройте панель Data API, чтобы скопировать выделенный ключ Data API. Сначала расходуются кредиты тарифа; дополнительное использование списывается с общего баланса аккаунта Capzy.

    Открыть Data API
  2. Выберите источник и действие

    Найдите в справочнике сайта метод, путь и обязательные параметры. Пример поиска Amazon отправляет query и domain на /v1/amazon/search.

    Параметры поиска Amazon
  3. Изучите JSON в песочнице

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

    Открыть песочницу поиска Amazon
amazon_search.py
# Install: pip install requests
import os
import requests

response = requests.get(
    "https://api.capzy.ai/v1/amazon/search",
    headers={"X-API-Key": os.environ["CAPZY_DATA_API_KEY"]},
    params={"query": "wireless earbuds", "domain": "com"},
    timeout=120,
)
response.raise_for_status()
data = response.json()
if response.status_code == 202:
    print("Pending:", data.get("status"), "Job:", data.get("jobId"))
    print("Inspect this job in https://capzy.ai/dashboard/data-api/runs")
else:
    for item in data.get("organic_results", []):
        print(item["title"], item.get("price"))
    print("Credits used:", response.headers.get("X-Credits-Used"))

Изучите контракт перед вызовом

Аутентификация общая для всех источников Data API. Методы, параметры и возвращаемые поля определяются каждым эндпоинтом.

X-API-KeyОбязательно · заголовок
Передавайте выделенный ключ Data API в этом заголовке. Храните его на сервере; в этих примерах он читается из CAPZY_DATA_API_KEY.
/v1/{source}/{path}Зависит от эндпоинта · путь
Следуйте методу и пути из справочника источника. Например, GET /v1/amazon/search принимает query и domain как параметры запроса.
X-Credits-UsedЗаголовок ответа
Показывает списанные за запрос кредиты. Цены эндпоинтов и скидки тарифов указаны в панели управления и справочнике источника.
X-Next-CursorЗаголовок ответа · если есть
Некоторые эндпоинты возвращают курсор следующей страницы. Используйте параметры пагинации конкретного эндпоинта; не все источники используют одинаковую модель пагинации.

Используйте реальные поля ответа источника

Ответ HTTP 200 для поиска Amazon содержит organic_results на верхнем уровне. HTTP 202 вместо этого возвращает оболочку статуса с jobId; проверьте её на странице «Запуски» в панели управления. Этот сокращённый успешный ответ содержит иллюстративные данные о товарах.

response.example.json
{
  "search_information": {
    "query": "wireless earbuds"
  },
  "organic_results": [
    {
      "title": "Example wireless earbuds",
      "price": "$27.99",
      "extracted_price": 27.99,
      "asin": "EXAMPLE001"
    }
  ]
}

organic_results · названия, цены, ASIN

Параметры

Цены

Тарифы Data API включают ежемесячный объём кредитов. Дополнительное использование списывается с общего баланса аккаунта Capzy. Актуальную цену эндпоинта в кредитах смотрите в справочнике источника.

Загрузка актуальных цен…

Что нужно знать

Где открывается песочница?

В разделе «Панель управления → Data API → Парсеры». Ссылки на источники открывают конструктор источника. Ссылки на эндпоинты сразу выбирают нужное действие, чтобы вы могли проверить обязательные входные данные перед запуском.

Можно ли использовать API-ключ решателя?

Используйте выделенный ключ Data API из панели Data API. У Data API свои настройки тарифа и включённые кредиты, а дополнительное использование оплачивается с общего баланса аккаунта Capzy.

Все источники возвращают одинаковый JSON?

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

Что, если эндпоинт помечен как «скоро»?

Панель управления отмечает эндпоинты, которые не проверены или недоступны для запуска. Используйте поддерживаемые действия, указанные там; одна лишь запись в справочнике не означает, что эндпоинт готов.

Найдите источник. Попробуйте реальный запрос.

Песочница в панели управления объединяет входные данные, ответ и актуальные цены.

Открыть песочницу