Гайд API для AI-агентів

Базове посилання та формат запиту

Запити використовують https://seohabit.com/api/v1. Надсилайте тіла JSON із Content-Type: application/json. Проєкти сайтів і перебіг автоматичних подань потребують автентифікації. Частота запитів обмежена.

Моніторинг подань з інших джерел

Створіть проект з даними про дозволені директори, щоб автоматично відправляти їх до відповідних постачальників. Максимум двох спроб на день UTC, зупиняється після п’яти підтверджених директорів. SEOHabit вибирає відповідних директорів у фоновому режимі; користувачі не переглядають або вибирають список директорів. Якщо жодного відповідного постачальника немає, проект чекає. Підтвердження не є публікацією чи підтвердженим backlink.

Перевіряти стан завдання

Перевіряйте статус URL, поки робота не досягне completed або failed. Аутентифікуйте кожен запит токеном доступу до роботи у заголовку. Токен роботи надає доступ лише до своєї роботи.

curl 'https://seohabit.com/api/v1/jobs/job_example' \
  -H 'X-Access-Token: YOUR_JOB_ACCESS_TOKEN'

Відповіді містять queued, running, completed, або failed; result — null, поки не доступний.

Аккаунти, ключі проектів, оплачувані дії

Обліковий запис та входження в систему встановлюють HttpOnly sh_session кук. Записи кук у браузері перевіряються на походження. Для інтеграцій, увійшовши в систему, можна створити API-ключ, що відповідає проекту, з вказаними діапазонами, і відправити його як Authorization: Bearer shk_…. Ключи не можуть отримати доступ до іншого проекту, а обмеження ключів обмежують доступні операції. Зберігайте сесійні коки та API-ключі — ніколи не включайте їх у посилання.

Завдання з ключовими словами приймають details.keyword, опційно details.language (за замовленням en) та опційно вказаний details.pageUrl. Рекомендації відкривають підтвердження сторінки та позначають невідомий мовний або пошуковий попит.

Аудит сайту може бути відкладений на безкоштовному проекті за обмеженнями. Моніторинг backlink, створення завдань та виконання завдань вимагають підтвердженого сайту та активної підписки. Платний дія вимагає, щоб особа встановила власність та явно отримала підписку через процес оплати. Не починайте оформлення, підписки чи дозволяйте зміни на іншому осьовому. Виконання завдань не є підтвердженням, що зміна була впроваджена; готове завдання вимагає перевірки та підтвердження користувачем.

Ключі проектів підтримують project:read, project:write, checks:write, tasks:write. Ключ застосовується тільки до свого проекту. Див. Документ OpenAPI для шляхів та форматів запитів.

Помилки та безпека

Помилки відображаються у форматі JSON з error та message. Загальний набір відповідей включає 400 для неправильного вводу або небезпечних URL, 401 для відсутності автентифікації облікового запису, 403 для забороненого походження або діапазону, 404 для недоступних ресурсів, 409 для конфліктів, 429 для обмежень швидкості, 402 у випадку, коли платний дія вимагає активної підписки.

Перевіряйте лише публічні сторінки, на які ви маєте дозвіл. Сервіс блокує приватні та локальні мережеві адреси, а також дотримується політики розширення сайту, якщо вона доступна. Для повторних POST-запитів використовуйте ключі ідемпотентності, а для відповідей на обмеження швидкості використовуйте відмову від запиту.