Developer API

REST API Adexium для внешних интеграторов: кампании, креативы (assets), баланс, справочники таргетинга и аналитика кампаний.

Base URL: https://api.adexium.io

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

К каждому запросу добавляйте API-ключ:

Authorization: Bearer <api_key>

Ключ доступен в настройках аккаунта. Для пользователя должно быть включено API-доступ (isApiAvailable).

Интерактивная документация

Полное описание endpoints, схем запросов/ответов и «Try it out»:

https://api.adexium.io/developer/api/doc

OpenAPI JSON (для генераторов кода и MCP tools):

https://api.adexium.io/api/doc.json

Типичный сценарий

1. Загрузить креатив — POST /api/v1/assets/from-url или POST /api/v1/assets → в ответе path
2. Создать кампанию — POST /api/v1/campaigns/{channel} с creatives[].creative = этот path
3. Список и изменения — GET /api/v1/campaigns, GET/PATCH /api/v1/campaigns/{id}
4. Статистика — GET /api/v1/campaigns/stats/{id}?startDate=...&endDate=...&splitBy=country

Каналы для create: tma, ime_messenger, web_pops, web_inpage, web_push, bot.

Интеграция через MCP

AI-агенты (Cursor, Claude Desktop и др.) можно подключить к Adexium через Model Context Protocol (MCP). MCP-сервер — тонкая обёртка над HTTP: агент вызывает tools, сервер ходит в https://api.adexium.io/api/v1/... с Authorization: Bearer <api_key>.

flowchart LR
    Agent[AI Agent] --> MCP[MCP Server]
    MCP -->|Bearer api_key| API["api.adexium.io /api/v1"]

Рекомендуемые tools

Tool	HTTP
get_balance	GET /api/v1/account/balance
list_campaigns	GET /api/v1/campaigns
get_campaign / update_campaign	GET / PATCH /api/v1/campaigns/{id}
create_campaign	POST /api/v1/campaigns/{channel}
upload_asset_from_url	POST /api/v1/assets/from-url
upload_asset_file	POST /api/v1/assets (multipart)
get_campaign_stats	GET /api/v1/campaigns/stats/{id}
list_dictionary	GET /api/v1/dictionaries/{type}

Схемы tools можно сгенерировать из OpenAPI spec или описать вручную.

Создание кампании с картинкой

1. upload_asset_from_url или upload_asset_file → получить path
2. create_campaign с creatives[].creative = path (не передавайте большой base64 через chat)
3. list_campaigns / get_campaign — когда нужен id для PATCH или stats

Пример конфигурации Cursor

В MCP settings (mcp.json или Cursor Settings → MCP):

{
  "mcpServers": {
    "adexium": {
      "command": "node",
      "args": ["/path/to/your-adexium-mcp/dist/index.js"],
      "env": {
        "ADEXIUM_API_BASE": "https://api.adexium.io",
        "ADEXIUM_API_KEY": "your-api-key"
      }
    }
  }
}

Укажите путь к вашему MCP-серверу (реализация не входит в этот репозиторий).

Безопасность и лимиты

• API-ключ только в env / secrets MCP-сервера — не в промптах, git и клиентском коде.
• /api/v1 ограничен ~2 запросами в секунду на IP. Обрабатывайте HTTP 429 (backoff/retry) в MCP-сервере.