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

Интеграция с партнерской программой

Начало работы

Добро пожаловать в API документацию! Наш API позволяет легко интегрировать отслеживание кликов и конверсий.

Основные возможности:

  • Отслеживание кликов
  • Отслеживание конверсий

Получение API ключа

1

Авторизуйтесь

В личном кабинете рекламодателя

2

Настройки

Раздел "API настройки"

3

Сгенерируйте

Кнопка "Сгенерировать новый ключ"

# Ваш API-ключ (храните в секрете!)
exampleApiToken012345678900000000000000000000000
Никогда не передавайте ключ третьим лицам и не размещайте в публичных репозиториях

Отслеживание кликов

curl -X POST https://linkoffer.ru/api/clicks 
-H "Authorization: Bearer your_api_key" 
-H "Content-Type: application/json"
-d '{
  "project": "1", // ID проекта (Можно получить при просмотре проекта, нажав на проекте кнопку "Просмотр")
  "partner": "1", // ID партнёра (Указывается автоматически при генерации партнёрской ссылки)
  "referrer": "1", // ID платформы партнёра (Откуда пришёл пользователь)
}'

Отслеживание конверсий

Код для страницы успешного завершения:

curl -X POST 'https://linkoffer.ru/api/conversions' \
-H "Authorization: Bearer your_api_key" \
-H "Content-Type: application/json" \
-d '{
  "project": "1", // ID проекта (Можно получить при просмотре проекта, нажав на проекте кнопку "Просмотр")
  "partner": "1", // ID партнёра (Указывается автоматически при генерации партнёрской ссылки)
  "referrer": "1", // ID платформы партнёра (Откуда пришёл пользователь)
  "amount": "1", // Цена конверсии (Опциональный параметр, должен быть не менее 85% от установленной цены)
  "details": "Конверсия" // Информация о конверсии. Пример: покупка, подписка и т.д. (Опциональный параметр)
}'

Примеры запросов

POST api/clicks HTTP/1.1
Host: linkoffer.ru
Authorization: Bearer your_api_key

Коды ошибок

Код Описание
400Неверный запрос
401Не авторизован
429Лимит запросов
500Ошибка сервера