Справочник разработчика

Использование DomScan с ИИ-агентами

Изучите документацию API Использование DomScan с ИИ-агентами, параметры запросов, поля ответов, примеры кода и обработку ошибок для интеграций DomScan.

Использование DomScan с ИИ-агентами

Подключите DomScan к Claude, ChatGPT, Cursor, VS Code, Codex и Windsurf через MCP, дайте агентам для программирования нужные правила работы с API и начните с готовых промптов.

MCP или REST API?

Используйте MCP, когда решает ассистент

Подключайте MCP-сервер, когда ассистент сам выбирает, какие проверки запускать по ходу разговора. Он самостоятельно находит инструменты DomScan, входит через ваш аккаунт или по API-ключу и получает структурированные результаты с той же классификацией, стоимостью в кредитах и кодами ошибок, что и API.

Используйте REST, когда решает ваш код

Вызывайте REST API из кода, который работает без ассистента: плановые задачи, массовые конвейеры, бэкенды и проверки в CI. Если агент для программирования пишет код, который попадёт в ваш продукт, пусть он вызывает REST API по описанию OpenAPI.

Многие команды используют оба варианта: MCP для исследования и прототипов в чате или редакторе и REST API в коде, который пишет агент. Оба используют один и тот же API-ключ и баланс кредитов.

Подключитесь к своему ИИ-инструменту

Установите MCP-сервер DomScan в один клик или выполните одну команду в терминале. При первом запуске проверки инструмент попросит вас войти в DomScan.

Claude Code
claude mcp add --transport http domscan https://domscan.net/mcp
Claude Code с API-ключом
claude mcp add --transport http domscan https://domscan.net/mcp --header "X-API-Key: YOUR_API_KEY"
Codex
codex mcp add domscan --url https://domscan.net/mcp
Вход в Codex
codex mcp login domscan

Эти ссылки и команды никогда не содержат ваш API-ключ. Инструменты с поддержкой входа подключаются напрямую к вашему аккаунту DomScan. Чтобы использовать ключ, замените YOUR_API_KEY на ключ из раздела ваши API-ключи.

Настройка по инструментам

Все инструменты подключаются к одному и тому же MCP-серверу по адресу https://domscan.net/mcp. Инструменты с поддержкой входа открывают окно входа в DomScan при первом запуске проверки. Остальные передают ваш API-ключ в заголовке X-API-Key.

Claude Code

Выполните это в терминале. При первом использовании DomScan Claude Code попросит вас войти. Добавьте --scope user, чтобы сделать DomScan доступным в каждом проекте.

Claude Code
claude mcp add --transport http domscan https://domscan.net/mcp
Claude Code с API-ключом
claude mcp add --transport http domscan https://domscan.net/mcp --header "X-API-Key: YOUR_API_KEY"

Cursor

Используйте кнопку Add to Cursor выше или добавьте эту запись в ~/.cursor/mcp.json для всех проектов либо в .cursor/mcp.json для одного проекта.

mcp.json
{
  "mcpServers": {
    "domscan": {
      "url": "https://domscan.net/mcp"
    }
  }
}

VS Code

Используйте кнопку Add to VS Code выше или добавьте эту запись в .vscode/mcp.json в вашем рабочем пространстве. VS Code попросит вас войти при запуске сервера.

.vscode/mcp.json
{
  "servers": {
    "domscan": {
      "type": "http",
      "url": "https://domscan.net/mcp"
    }
  }
}

Codex

Добавьте сервер, затем выполните вход. Чтобы вместо этого использовать API-ключ, добавьте этот блок в ~/.codex/config.toml и задайте DOMSCAN_API_KEY в своём окружении.

Codex
codex mcp add domscan --url https://domscan.net/mcp
Вход в Codex
codex mcp login domscan
~/.codex/config.toml
[mcp_servers.domscan]
url = "https://domscan.net/mcp"
env_http_headers = { "X-API-Key" = "DOMSCAN_API_KEY" }

ChatGPT

Включите режим разработчика в ChatGPT в разделе Settings, Connectors, Advanced. Затем создайте коннектор с этим URL и выберите OAuth. Пошаговые инструкции есть на странице: страница настройки MCP.

URL MCP-сервера
https://domscan.net/mcp

Claude

В Claude в браузере или в Claude Desktop откройте Settings, затем Connectors и добавьте собственный коннектор с именем DomScan и этим URL. Claude откроет окно входа в DomScan, чтобы завершить настройку.

URL MCP-сервера
https://domscan.net/mcp

Windsurf

Откройте настройки MCP в Windsurf, перейдите к исходной конфигурации и добавьте эту запись в mcp_config.json. Замените YOUR_API_KEY своим ключом.

mcp_config.json
{
  "mcpServers": {
    "domscan": {
      "serverUrl": "https://domscan.net/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}

Эти ссылки и команды никогда не содержат ваш API-ключ. Инструменты с поддержкой входа подключаются напрямую к вашему аккаунту DomScan. Чтобы использовать ключ, замените YOUR_API_KEY на ключ из раздела ваши API-ключи.

Инструкции для агентов для программирования

Вставьте это в AGENTS.md, CLAUDE.md или файл правил вашего редактора, чтобы агенты для программирования правильно обращались к DomScan.

AGENTS.md
## DomScan API

Используй DomScan (https://domscan.net) для проверок доступности доменов, DNS, WHOIS и RDAP, SSL, безопасности почты и оценки стоимости.

- Базовый URL: `https://domscan.net`. Эндпоинты находятся под `/v1`.
- Аутентификация: отправляй `X-API-Key: $DOMSCAN_API_KEY` (или `Authorization: Bearer $DOMSCAN_API_KEY`). Читай ключ из окружения. Никогда не вшивай его в код, не логируй и не помещай в URL.
- Контракт: перед выбором эндпоинта или параметра прочитай описание OpenAPI по адресу https://domscan.net/v1/openapi.json и не угадывай имена параметров. Краткое описание сайта для LLM находится по адресу https://domscan.net/llms.txt.
- MCP: удалённый сервер находится по адресу https://domscan.net/mcp (streamable HTTP, вход или те же заголовки с API-ключом).
- Кредиты: большинство эндпоинтов расходует кредиты. Перед массовой или повторяющейся работой вызови `POST /v1/estimate` с полями `method`, `path`, `query` и `body` запроса либо добавь `dry_run=true` к массовым эндпоинтам, эндпоинтам сравнения, recipe и цен. Оба способа бесплатны. Отслеживай заголовки ответа `X-Credits-Charged` и `X-Credits-Remaining`.
- Массовые проверки: проверяй до 50 полных доменных имён одним запросом `POST /v1/status/bulk` вместо цикла по отдельным проверкам.
- Повторы: отправляй заголовок `Idempotency-Key` (например, UUID) в POST-запросах, которые списывают кредиты. Повтор того же запроса с тем же ключом в течение 24 часов возвращает сохранённый ответ без повторного списания. Повторяй только если `error.retryable` равно true, а при 429 жди время из `Retry-After`.
- Ошибки: тело каждой ошибки имеет вид `{"error": {"type", "code", "message", "status", "retryable", "request_id", ...}}`. Ветвись по `error.code`, например `INVALID_PARAMETER`, `INSUFFICIENT_CREDITS` или `RATE_LIMITED`, а не по тексту сообщения.
- Неизвестно не значит отсутствует: результаты содержат `classification.status` со значением `present`, `absent` или `unknown`. Считай `unknown` сигналом "повтори позже", а не признаком доступности или отсутствия, и никогда не принимай отсутствие за доказательство того, что имя можно зарегистрировать или занять.
- Актуальность: эндпоинты, которые могут ответить по недавним данным, принимают `max_age` в секундах (`max_age=0` запрашивает свежую проверку) и возвращают `cache_age_s`. Стоимость от этого не меняется.
- Ответы меньшего размера: добавь `fields=a,b.c` или `compact=true` в строку запроса. Ни то, ни другое не меняет стоимость.
- Подробнее: https://domscan.net/AGENTS.md и https://domscan.net/docs.

Промпты для начала

Скопируйте промпт или откройте его в своём ассистенте. Сначала подключите DomScan, чтобы ассистент мог выполнять проверки.

  1. С помощью DomScan проверь, доступны ли эти 50 имён как домены .com: [вставьте имена]. Сначала оцени стоимость в кредитах и покажи её мне, прежде чем что-либо запускать. Затем выведи доступные, занятые и неизвестные результаты отдельными списками и не считай неизвестные результаты доступными.

  2. С помощью DomScan проверь безопасность почты для example.com: SPF, DKIM, DMARC и статус в чёрных списках. Объясни каждую проблему простым языком и предложи DNS-запись, которая её исправит.

  3. Я думаю купить example.com. С помощью DomScan проверь его WHOIS и даты регистрации, DNS, SSL-сертификат, репутацию и оценочную стоимость, затем кратко опиши риски и то, что мне стоит проверить перед оплатой.

  4. С помощью DomScan найди уже зарегистрированные домены, похожие на example.com, и домены для тайпосквоттинга. Отсортируй их по уровню риска и отметь те, у которых есть сайт или почтовый сервер.

  5. Добавь DomScan в этот проект. Прочитай https://domscan.net/AGENTS.md и https://domscan.net/v1/openapi.json, затем напиши небольшой типизированный клиент для POST /v1/status/bulk, который читает DOMSCAN_API_KEY из окружения, отправляет заголовок Idempotency-Key и хранит неизвестные результаты отдельно от доступных. Добавь тесты.

Машиночитаемые ресурсы

Направляйте агентов на эти публичные файлы вместо копирования документации в промпты.