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

Встройте превью в собственные инструменты и пайплайны

REST API управляет ссылками на превью, запускает QA-отчёты и проверяет распространение DNS по тем же правилам и лимитам тарифа, что и панель. Создавайте превью для каждого pull request, деплоя или переноса клиента.

curl
# List the links of the workspace
curl https://api.dnspeek.link/api/v1/links \
  -H "Authorization: Bearer $DNSPEEK_API_KEY"

# Create a preview link
curl -X POST https://api.dnspeek.link/api/v1/links \
  -H "Authorization: Bearer $DNSPEEK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"targetDomain":"shop.example.com","targetIp":"203.0.113.10"}'

Что вы получаете

  • Ссылки, отчёты и DNS

    Создавайте, изменяйте и удаляйте ссылки на превью, запускайте QA-отчёты и читайте их результаты, проверяйте распространение DNS.

  • Ключи под вашим контролем

    Доступ на чтение и запись или только чтение, срок действия, список разрешённых IP и ротация в один клик. Для каждого ключа видно последнее использование.

  • События там, где работает команда

    Отправляйте распространение DNS, результаты QA, согласования клиентов и истекающие ссылки в Slack, Telegram, Microsoft Teams, Discord, на email или в подписанный вебхук.

  • Превью для каждого pull request

    GitHub Action создаёт или обновляет превью для каждого pull request, может запустить QA-отчёт и комментирует результаты в нём.

Как это работает

  1. 1

    Создайте API-ключ

    Откройте API-ключи на боковой панели, назовите ключ и выберите доступ, срок действия и разрешённые IP. Скопируйте его: он показывается один раз.

  2. 2

    Вызовите API

    Передайте ключ как Bearer-токен. Все эндпоинты, поля и коды ошибок — в справочнике REST API.

  3. 3

    Передайте ссылку дальше

    Добавьте URL превью в pull request, тикет или приветственное письмо клиенту.

Тарифы

Что входит в каждый тариф для этой возможности, по текущему каталогу тарифов.

  • Доступ к API

    Free
    Не входит
    Pro
    Входит
    Agency
    Входит
    Provider
    Входит
  • Запросов к API / мин на ключ

    Free
    Не входит
    Pro
    60
    Agency
    300
    Provider
    1 000
  • Строк в одном массовом импорте

    Free
    Не входит
    Pro
    100
    Agency
    1 000
    Provider
    10 000
  • Каналы уведомлений

    Free
    Не входит
    Pro
    3
    Agency
    20
    Provider
    Без ограничений

Сравнить все тарифы

Ответы на вопросы

На каких тарифах есть API?

На тарифах с доступом к API; тарифы и их лимиты запросов показаны в таблице выше.

Могут ли клиенты открыть заполненную форму превью без ключа?

Да. Ссылка на /new с доменом и IP в адресе открывает заполненную форму превью на любом тарифе. Ничего не создаётся, пока клиент не нажмёт кнопку.

Чьи ссылки создаёт ключ?

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

Есть ли лимит запросов?

Да, количество запросов в минуту для каждого ключа зависит от тарифа. Поддерживаются безопасные повторы с ключом идемпотентности.

Проверьте новый сервер раньше посетителей

Бесплатно, без карты, а для первой ссылки не нужен аккаунт.

Нет сервера под рукой? Посмотрите демо