API индексации

01 Доступ по запросу

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

Ниже – весь набор целиком, как он спроектирован. Список короткий, и это сознательно. Не хватает чего-то нужного вам – напишите: один эндпоинт, который реально вызывают, полезнее десяти, которые не вызывает никто.

02 Как он устроен

REST поверх HTTPS, JSON на входе и на выходе, один ключ в одном заголовке, никаких SDK. Работать с ним может всё, что умеет отправить HTTP-запрос.

• Один ключ на аккаунт. Выдаётся вам, меняется или отзывается по запросу.
• Один заголовок. Никаких подписей, никаких плясок с OAuth, никаких токенов для обновления.
• Те же объекты, что вы уже видите. Заказ, созданный через API, – это тот же заказ в вашем кабинете: те же статусы, та же детализация по каждому URL, та же история.
• Никакого отдельного прайса. Та же цена и тот же баланс, каким бы способом заказ ни был создан.

Второго продукта здесь нет. Это те же операции кабинета, к которым приделали машинную дверь.

03 Ваш ключ

Ключ передаётся с каждым вызовом. Вся аутентификация выглядит так:

Ключ определяет аккаунт и тратит баланс этого аккаунта. Его можно сменить или отозвать в любой момент, не трогая пароль и открытые сессии. Относитесь к нему как к учётным данным: его место на вашем сервере, а не в браузере, публичном репозитории или тикете поддержки.

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

04 Что можно вызвать

Шесть операций, один в один повторяющих то, что делает кабинет:

• Создать заказ – отправить список URL и получить заказ в виде черновика. Ничего не списывается и ничего пока не ставится в очередь.
• Запустить его – отдельный вызов, который стартует кампанию и списывает средства с баланса. Вызов отдельный не случайно: черновик – единственное безопасное место, где список ещё можно проверить.
• Получить список заказов – от новых к старым, постранично, с состоянием каждого.
• Прочитать один заказ – его статус, счётчики и детализацию по каждому URL по мере хода кампании.
• Проверить баланс – сколько осталось, ровно та же цифра, что и в кабинете.
• Удалить черновик – пока он ещё черновик. После запуска отменять уже нечего, см. политику возвратов.

В первой версии нет вебхуков, нет массового экспорта, нет эндпоинтов отчётности – вы опрашиваете заказ и получаете его состояние. Если опроса для вашей задачи не хватает, скажите и об этом.

05 Лимиты и правила

Здесь нет ничего специфичного для API. Это тот же сервис, просто другая дверь:

• Те же минимум и максимум URL в заказе, что и в кабинете, и сколько угодно заказов – см. цены.
• Та же цена за URL, списывается с баланса в момент запуска заказа.
• Лимиты частоты на ключ: на реальную автоматизацию хватит, а цикл с ошибкой они переживут.
• Политика допустимого использования действует ровно так же, как в кабинете. Ключ не расширяет того, что вам можно отправлять.

Ошибки возвращаются в JSON с кодом статуса, который означает именно то, что означает. Отклонённый URL отмечается на уровне URL, а не как проваленный запрос: одна некорректная строка не выбрасывает остальной список.

06 Чем он не является

Страницы про API обычно обещают больше, чем дают, поэтому скажем прямо:

• Это не способ купить методику. Он создаёт заказы. Что происходит с URL дальше – тот же закрытый пайплайн, описанный в условиях использования, и ни один эндпоинт его не раскроет.
• Это не гарантия индексации. Принятый заказ означает, что работа поставлена в очередь, – ровно то же, что означает нажатие кнопки в кабинете, не больше.
• Это не интерфейс для реселлеров. Перепродажа и white-label требуют сначала письменного соглашения: sales@index-pages.com.
• Это не те эндпоинты, которыми пользуется наш собственный парк воркеров. Они существуют, они внутренние, они не для клиентов, и эта страница не о них.

07 Запросить ключ

Напишите на support@index-pages.com с адреса, указанного в аккаунте, и добавьте пару строк о том, что собираетесь автоматизировать. Именно эта вторая часть двигает запрос вверх по списку: мы строим под реальное использование, а не под форму запроса функций.

График здесь диктует спрос. Ни списка ожидания, ни бета-программы, ни фильтра: нужно – скажите. Всё остальное – на странице контактов.