Предложение API вашим клиентам

Ваши клиенты могут автоматизировать свои ссылки так же, как вы автоматизируете партнёрский аккаунт. Эта страница — сценарий превращения API в возможность вашего продукта, включая текст, который можно адаптировать для собственной документации разработчика.

Как это устроено

• Клиенты создают собственные ключи. У каждого рабочего пространства на тарифе с доступом к API есть раздел Настройки → ключи API в брендированной панели. Ключи принадлежат рабочему пространству: ваш партнёрский ключ здесь ни при чём, а клиент может добраться только до собственных данных.
• Хост общий. Все запросы идут на https://api.linkprofit.com/v1. В версии v1 собственный домен API для каждого партнёра недоступен — документируйте хост как технический эндпоинт вашего сервиса. В ответах нет никакого брендинга LinkProfit: домены, ссылки и аналитика в полезной нагрузке принадлежат вашему клиенту.
• Вы решаете, кому это доступно. Доступ к API — флаг api_access в тарифах, которые вы продаёте. Клиенты на тарифах без этого флага получают 403 plan_restricted — чистый момент для допродажи. Лимиты частоты следуют за ключом, поэтому более дорогой тариф может идти с более высоким лимитом.

Что написать в своей документации

Минимальная страница для разработчиков ваших клиентов нуждается в четырёх вещах:

1. Где живут ключи — «Настройки → ключи API в вашей панели; ключ показывается один раз».
2. Базовый адрес — https://api.linkprofit.com/v1, аутентификация через Authorization: Bearer <key>.
3. Быстрый старт — скопируйте быстрый старт и замените домен из примера на свой.
4. Справочник — дайте ссылку на интерактивный справочник или разместите файл OpenAPI (https://linkprofit.com/openapi.json) в собственном инструменте документации; он отрисовывается в Scalar, Swagger UI, Redoc и Postman как есть.

Webhook для клиентов

Клиентские рабочие пространства регистрируют собственные эндпоинты webhook для событий ссылок, доменов и порогов по кликам. События партнёрского уровня — подписки, платежи — остаются на ваших партнёрских эндпоинтах и клиентам никогда не доставляются.

Ограничения, о которых стоит упомянуть

• Ключи привязаны к рабочему пространству: агентский клиент, ведущий несколько рабочих пространств, создаёт ключ в каждом.
• Журнал аудита относит изменения через API к конкретному ключу, и клиент видит это в своей панели — разговоры с поддержкой начинаются с фактов.
• Всё, что API записывает, подчиняется тем же квотам тарифа, что и панель: клиент не сможет скриптом обойти лимит ссылок, который вы ему продали.