Для разработчиков

Документация UrlFlow API

Полный программный доступ к платформе. Создавайте умные ссылки, настраивайте редиректы и выгружайте аналитику через RESTful интерфейс. Интегрируйте UrlFlow в свои CRM, лендинги и мобильные приложения за считанные минуты.

Код API запроса UrlFlow в терминале

Быстрый старт: Получение доступа

Начать работу с UrlFlow API легко. Вам понадобится аккаунт разработчика и ключ доступа, который генерируется в панели управления.

1

Регистрация

Зарегистрируйте аккаунт или войдите в существующий. Перейдите в раздел Настройки профиля.

2

Генерация ключа

В разделе API Keys нажмите "Создать ключ". Назовите его (например, "Production App") и скопируйте токен.

3

Первый запрос

Добавьте токен в заголовок Authorization и отправьте GET запрос на базовый URL для проверки.

Аутентификация

UrlFlow использует Bearer токены для аутентификации API-запросов. Каждый запрос должен содержать заголовок Authorization.

// Пример заголовка запроса
Authorization: Bearer ufl_live_sk_8f4a2b9c1d0e3f7g6h5i4j3k2l1m0n9o

Важно: Никогда не передавайте секретные ключи (начинающиеся с ufl_live_sk_) на клиентскую сторону (браузер). Используйте их только на сервере. Для публичных приложений используйте OAuth 2.0.

Основные эндпоинты

Взаимодействие с платформой происходит через базовый URL: https://api.urlflow.io/v1

POST

/links

Создает новую сокращенную ссылку. Принимает целевой URL, параметры отслеживания, геотаргетинг и срок действия ссылки.

GET

/links/{id}/stats

Возвращает детальную статистику по конкретной ссылке: клики, UTM-метки, источники, устройства и географию за выбранный период.

PUT

/links/{id}

Обновляет параметры существующей ссылки. Позволяет менять целевую страницу (Destination URL) без изменения короткой ссылки.

DELETE

/links/{id}

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

Примеры кода

Создание новой ссылки с параметрами геотаргетинга.

Python (Requests)

import requests

url = "https://api.urlflow.io/v1/links"
headers = {
  "Authorization": "Bearer YOUR_API_KEY",
  "Content-Type": "application/json"
}

payload = {
  "destination": "https://mysite.com/promo",
  "domain": "ufl.io"
}

response = requests.post(url, json=payload, headers=headers)

cURL

curl -X POST https://api.urlflow.io/v1/links \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "destination": "https://mysite.com/promo",
    "domain": "ufl.io"
  }'

Коды ответов и ошибки

UrlFlow использует стандартные HTTP статус-коды для индикации успеха или неудачи операции.

  • 200 Успешный запрос
  • 201 Ресурс создан
  • 400 Неверный формат данных
  • 401 Ошибка аутентификации
  • 429 Превышен лимит запросов

Лимиты и квоты

Чтобы обеспечить стабильность сервиса, применяются следующие ограничения:

Запросов в минуту (RPM) 60
Макс. размер тела запроса 50 KB
Макс. ссылок на аккаунт 10,000
Время жизни токена 12 часов

* Для увеличения лимитов свяжитесь с отделом продаж Enterprise.

Нужна помощь с интеграцией?

Наша команда технической поддержки готова помочь с настройкой API, отладкой запросов и оптимизацией скорости.

Написать в поддержку