SEOньоритаДокументация API
API v1Быстрый старт
Public API v1

Быстрый старт

Создайте отдельный ключ, выполните первый запрос и проверьте стандартную оболочку ответа.

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

  1. Откройте экран API-ключей и задайте понятное имя интеграции.
  2. Выберите только нужные scopes и проекты.
  3. Скопируйте секрет сразу: повторно он не показывается.
  4. Храните секрет в secret manager или переменной окружения.

2. Выполните первый запрос

GET/accesstoken:discover · встроено

Возвращает контекст самого ключа без workspaceId или projectId в URL.

Запросbash
curl "https://api.seonorita.ru/api/v1/access" \
  -H "Authorization: Bearer $SEO_API_TOKEN" \
  -H "Accept: application/json"
200 · Ответjson
{
  "data": {
    "apiVersion": "v1",
    "token": {
      "id": "<tokenId>",
      "name": "SEO-агент",
      "scopes": ["projects:read", "semantics:read", "positions:read"],
      "allProjects": false
    },
    "workspace": {
      "id": "<workspaceId>",
      "name": "Рабочая область агентства",
      "slug": "agency",
      "status": "ACTIVE"
    },
    "projects": [{
      "id": "<projectId>",
      "workspaceId": "<workspaceId>",
      "name": "Нейролюб",
      "domain": "neurolub.ru",
      "slug": "neirolub",
      "status": "ACTIVE"
    }]
  },
  "meta": { "requestId": "01J..." }
}

3. Используйте найденные идентификаторы

Подставляйте data.workspace.id и нужный data.projects[].id в остальные маршруты. Коллекция уже учитывает allowlist ключа и актуальные права создавшего его пользователя. Один ключ всегда относится к одной рабочей области; для другой рабочей области создайте отдельный ключ.

Следующий запросbash
curl "https://api.seonorita.ru/api/v1/projects/<projectId>/keywords?limit=100" \
  -H "Authorization: Bearer $SEO_API_TOKEN" \
  -H "Accept: application/json"

4. Обрабатывайте ответ

  • data содержит ресурс или массив ресурсов.
  • meta.requestId сохраняйте для диагностики.
  • У постраничных списков читайте page.hasNext и page.nextCursor.
  • Денежные и потенциально большие целые значения передаются строками.
  • Все даты — ISO 8601 в UTC.