Чтобы начать работу с API-интерфейсом, необходимо получить API-токен. Он доступен в разделе «Профиль» системы. Авторизуйтесь на сайте, чтобы видеть свой токен.

Данные для запроса передаются в POST-части запроса в чистом виде. Их не нужно каким-либо образом кодировать, не нужно помещать в JSON или XML-представление. Но если очень хочется, вы можете использовать JSON POST с заголовком Content-type: application/json.

Функции веб-мастера позволяют работать с потоками и получать статистическую информацию аккаунта.

Добавление лида

URL: https://my.finasset.ru/api/wm/push.json?id={token}

Функция позволяет добавить новый лид от имени вебмастера. Данные нового лида передаются в POST-запросе.

На входе функция принимает следующие данные о лиде:

Результатом выполнения функции является ассоциативный массив:

Пример успешного ответа функции:

{ "status" : "ok", "id" : 1234 }

Пример ответа функции при возникновении ошибки:

{ "status" : "error", "error" : "nooffer" }

Импорт цены клика

URL: https://my.finasset.ru/api/wm/cost.json?id={token}

Функция задаёт цену клика для потока по указанным условиям. Позволяет использовать функционал расчёта ROI. Данные могут передаваться как в GET, так и в POST-запросе. В запросе обязательно должны присутствовать параметры cpc или cost и хотя бы одно условие (даты, поток, UTM-метки). Цена присваивается только тем кликам, которые система считает входящими - уникальеым кликам на прелендингах и уникальным кликам на лендингах без использования прелендинга.

На входе функция принимает следующие данные о цене клика:

Вы также можете одновременно обновлять несколько ценников одним запросом, для этого объедините все запросы в массив batch и отправьте его через POST, например:

{
    "batch": [
        {
            "flow": 42,
            "cost": 1984,
            "currency": "usd"
        },
        {
            "from": "2020-04-04 00:00:00",
            "to": "2020-04-07 23:59:59",
            "cpc": 1.337,
            "currency": "eur"
        }
    ]
}

Результатом выполнения функции является ассоциативный массив:

Пример успешного ответа функции:

{ "status" : "ok", "ok" : 1, "bad": 0 }

Пример ответа функции при возникновении ошибки:

{ "status" : "error", "error" : "nooffer" }

Статистика по лидам

URL: https://my.finasset.ru/api/wm/lead.json?id={token}

ID функции - lead. Функция предоставляет список лидов и их статус по списку идентификаторов или за указанную дату.

Результатом выполнения функции является массив лидов. Каждый элемент включает в себя следующие поля:

Пример ответа функции:

[
    {
	"id": 10101,
	"time": "1498127780",
	"stage": "trash",
	"phase": 5,
	"reason": 1,
	"reason_text": "Некорректный номер",
	"hold": 0,
	"comment": null,
	"cash": 700,
	"offer": 234,
	"offer_name": "Shiny test offer",
	"flow": 4838,
	"site": 123,
	"site_url": "land.cpa/test-offer",
	"space": 0,
	"space_url": false,
	"ip": "12.34.56.78",
	"utm_source": "google",
	"utm_content": "321012",
	"utm_campaign": "321",
	"utm_medium": "cpc",
	"utm_term": "neverland"
    }
]

Статистика по датам

URL: https://my.finasset.ru/api/wm/stats.json?id={token}

Функция предоставляет статистику по кликам и заказам, разбитую по датам, аналогично разделу «Статистика».

На входе функция получает следующие параметры:

Результатом выполнения функции является ассоциативный массив. Идентификатором каждого элемента служит дата статистики в формате ГГГГММДД. Каждый элемент включает в себя следующие поля:

Пример ответа функции:

{
    "20241121": {
	"id": "20241121",
	"space": 321,
	"suni": 291,
	"sgood": 153,
	"stime": 23.45,
	"clicks": 113,
	"unique": 93,
	"time": 34.56,
	"good": 80,
	"ct": 13,
	"mt": 9100,
	"ca": 5,
	"ma": 3500,
	"cc": 3,
	"mc": 2100,
	"cw": 5,
	"mw": 3500,
	"cw": 1,
	"mw": 1000,
	"cx": 2,
	"mx": 1400
    }
}

Статистика по кликам

URL: https://my.finasset.ru/api/wm/click.json?id={token}

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

На входе функция получает следующие параметры:

Результатом выполнения функции является ассоциативный массив. Идентификатором каждого элемента служит идентификатор выбранного элемента группировки. Каждый элемент включает в себя следующие поля:

Пример ответа функции:

{
    "123": {
	"id": "123",
	"name": "Shiny test offer",
	"space": 321,
	"suni": 291,
	"sgood": 153,
	"stime": 23.45,
	"clicks": 113,
	"unique": 93,
	"time": 34.56,
	"good": 80,
	"ct": 13,
	"mt": 9100,
	"ca": 5,
	"ma": 3500,
	"cc": 3,
	"mc": 2100,
	"cw": 5,
	"mw": 3500,
	"cw": 1,
	"mw": 1000,
	"cx": 2,
	"mx": 1400
    }
}

Список офферов

URL: https://my.finasset.ru/api/wm/offers.json?id={token}

Функция позволяет получить список активных офферов, их описание и данные о конверсии. Чтобы показать информацию только по одному офферу, укажите его идентификатор в параметре offer.

Результатом выполнения функции является ассоциативный массив списка офферов со следующими полями:

Пример ответа сервера:

{
    "31": {
        "id": 31,
        "name": "Shiny test offer",
        "short": "Testing",
        "cid": 2,
        "cat": "Health and beauty",
        "epc": 262.5,
        "cr": 150,
        "appr": 42.9,
        "geo": {
            "ru": {
                "code": "ru",
                "name": "Россия",
                "price": 990,
                "currency": "rub",
                "cr": 6.2,
                "epc": 18.4,
                "approve": 71.2,
                "desktop": {
                    "base": 600,
                    "upsale": 30,
                    "crossale": 30,
                    "percent": 0,
                    "currency": "rub"
                },
                "mobile": {
                    "base": 500,
                    "upsale": 25,
                    "crossale": 25,
                    "percent": 0,
                    "currency": "rub"
                }
            },
        },
        "land": {
            "123": {
                "id": 123,
                "url": "http://land.cpa/test-land/",
                "epc": 23.4,
                "cr": 5.6,
                "approve": 78.9,
                "mobile": 1,
                "default": true
            },
        },
        "space": {
            "234": {
                "id": 234,
                "url": "http://blog.cpa/test-space/",
                "epc": 12.3,
                "cr": 4.5,
                "approve": 67.8,
                "mobile": 0,
                "default": false
            },
        }
    }
}

Сайты оффера

URL: https://my.finasset.ru/api/wm/sites.json?id={token}

Функция позволяет получить список сайтов, прикреплённых к указанному офферу. На входе функция получает один параметр: offer - идентификатор оффера, для которого требуется получить список сайтов.

Результатом выполнения функции является ассоциативный массив с двумя полями: land и space. Первое содержит список лендингов данного оффера, второе - список доступных преленлингов. По каждому из сайтов представлена следующая информация:

Пример ответа сервера

{
    "land": {
        "123": {
            "id": 123,
            "url": "http://land.cpa/test-land/",
            "epc": 23.4,
            "cr": 5.6,
            "approve": 78.9,
            "mobile": 1
        },
    },
    "space": {
        "234": {
            "id": 234,
            "url": "http://blog.cpa/test-space/",
            "epc": 12.3,
            "cr": 4.5,
            "approve": 67.8,
            "mobile": 0
        },
    }
}

Список потоков

URL: https://my.finasset.ru/api/wm/flows.json?id={token}

Функция возвращает список потоков, созданных веб-мастером. На входе функция получает один параметр: offer - идентификатор оффера, для которого требуется получить список существующих потоков.

Результатом выполнения функции является ассоциативный массив со списком потоков:

Пример ответа функции:

{
    "123": {
        "id": 123,
        "url": "http://blog.cpa/test-space/?flow=123&l=234",
        "offer": 45,
        "offername": "Shiny test offer",
        "name": "Still shiny 45",
        "epc": 12.3,
        "cr": 4.5,
        "total": 550,
        "site": 234,
        "siteurl": "land.cpa/test-site",
        "space": 345,
        "spaceurl": "blog.cpa/test-space",
        "traffback": "",
        "postback": "http://help.me/iamtrapped.php?key=inroom&number=5&status={stage}",
        "metrika": "123456789",
        "google": "123-ABDC",
        "vkcom": "VK-ABCD-1234",
        "facebook": "1234-56-7890",
        "utm_source": "google",
        "utm_campaign": "343",
        "utm_content": "987652",
        "utm_term": "helloworld",
        "utm_medium": "cpc"
    },
}

Создание потока

URL: https://my.finasset.ru/api/wm/add.json?id={token}

Функция создаёт новый поток по офферу.

На входе функция получает идентификатор оффера, по которому требуется создать поток. Идентификатор оффера передаётся в параметре offer, список идентификаторов можно получить в функции offers.

Результатом выполнения функции является ассоциативный массив:

Пример успешного ответа функции:

{ "status" : "ok", "id" : 1234 }

Пример ответа функции при возникновении ошибки:

{ "status" : "error", "error" : "offer-inactive" }

Редактирование потока

URL: https://my.finasset.ru/api/wm/edit.json?id={token}

Функция позволяет изменить настройки потока. Идентификатор потока является обязательным параметром, остальные параметры не обязательны для передачи.

На входе функция получает следующие параметры:

Результатом выполнения функции является ассоциативный массив:

Пример успешного ответа функции:

{ "status" : "ok" }

Пример ответа функции при возникновении ошибки:

{ "status" : "error", "error" : "access-denied" }

Удаление потока

URL: https://my.finasset.ru/api/wm/del.json?id={token}

Функция удаляет поток. На входе она получает идентификатор потока, который требуется удалить. Идентификатор оффера передаётся в параметре flow.

Результатом выполнения функции является ассоциативный массив:

Пример успешного ответа функции:

{ "status" : "ok" }

Пример ответа функции при возникновении ошибки:

{ "status" : "error", "error" : "access-denied" }

API-интерфейс поставщика позволяет произвести интеграцию вашего собственного интерфейса с нашей системой обработки заказов.

Добавление заказа

URL: https://my.finasset.ru/api/comp/add.json?id={token}

Функция позволяет добавить новый лид от имени компании, без указания источника поступления лида. Данные нового лида передаются в POST-запросе.

На входе функция принимает следующие данные о лиде:

Результатом выполнения функции является ассоциативный массив:

Пример ответа функции:

{ "status" : "ok", "id" : 1234 }

Список заказов

URL: https://my.finasset.ru/api/comp/list.json?id={token}

Функция позволяет получить список заказов. Параметры отбора могут передаваться в GET или POST-запросе.

На входе функция может использовать следующие параметры для отбора заказов:

Результатом выполнения функции является массив элементов со следующими полями:

Пример ответа функции:

[
    {
        "id": 13131,
        "ext": 2424,
        "offer": 15,
        "offername": "Shiny test offer",
        "wm": 59,
        "stage": "approve",
        "phase": 3,
        "status": 8,
        "reason": 0,
        "check": 0,
        "site": 12,
        "siteurl": "land.cpa/test-offer",
        "space": 23,
        "spaceurl": "blog.cpa/test-space",
        "ip": "12.34.56.78",
        "time": 1732175051,
        "name": "John Doe",
        "gender": 0,
        "phone": "123456789000",
        "country": "ru",
        "index": "100000",
        "area": "",
        "city": "Moscow",
        "street": "Lenina street",
        "addr": "1",
        "comment": "Заберет у курьера в течение 2-5  дней",
        "count": 6,
        "items": {
            "12": [ 3, 665 ],
            "23": [ 1, 665 ],
            "34": [ 2, 665 ]
        },
        "delivery": 1,
        "discount": 0,
        "currency": "rub",
        "base": "0.00",
        "more": "0.00",
        "delpr": "350.00",
        "price": "4340.00"
    }
]

Смена статуса заказа

URL: https://my.finasset.ru/api/comp/status.json?id={token}

Функция позволяет обновить статус существующего заказа и изменить некоторые его поля. Все параметры могут передаваться как в POST, так и в GET-части запроса. Функция оптимальна для использования в PostBack-запросах.

На входе функция получает следующие параметры:

Обязательным являются только идентификатор заказа и статус, остальные поля используются по мере надобности. Результатом выполнения функции является ассоциативный массив:

Пример успешного ответа функции:

{ "status" : "ok" }

Пример ответа функции при возникновении ошибки:

{ "status" : "error", "error" : "access-denied" }

Редактирование заказа

URL: https://my.finasset.ru/api/comp/edit.json?id={token}

Функция позволяет отредактировать поля существующего заказа, обновить его статус. Часть параметров может передаваться в GET-части запроса.

На входе функция получает следующие параметры:

Обязательным является только поле идентификатора заказа, остальные поля используются по мере надобности. Результатом выполнения функции является ассоциативный массив:

Пример успешного ответа функции:

{ "status" : "ok" }

Пример ответа функции при возникновении ошибки:

{ "status" : "error", "error" : "access-denied" }

Аналитика заказов

URL: https://my.finasset.ru/api/comp/stats.json?id={token}

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

На входе функция получает следующие параметры:

Результатом выполнения функции является ассоциативный массив. Идентификатором каждого элемента служит идентификатор выбранного элемента группировки. Каждый элемент включает в себя следующие поля:

Пример ответа функции:

{
    "20190801": {
        "id": 20190801, // ИД элемента
        "name": "2019-08-01" // Название элемента
        "count": 24, // Количество
        "pay": 11150, // Сумма отчисления
        "app": 100, // Процент аппрува
        "apps": 100, // Процент аппрува при учёте треша
        "cash": { // Распределение по валютам
            "usd": [ // ISO-код валюты
                23, // Количество заказов
                40477 // Сумма по заказам
            ],
            "rub": [ 1, 13990 ]
        },
        "status": { // Распределение по статусам
            "6": { // ИД статуса
                "count": 24, // Количество заказов в этом статусе
                "pay": 11150, // Сумма отчислений
                "cash": { // Распределение по валютам
                    "usd": [ 23, 40477 ],
                    "rub": [ 1, 13990 ]
                }
            }
        },
    },
}

API-интерфейс агентства позволяет сторонним партнёрским сетям и арбитражным командам загружать лиды в систему и проверять статус их обработки с помощью выгрузки.

Добавление лида

URL: https://my.finasset.ru/api/ext/add.json?id={token}

Функция позволяет добавить новый лид от имени агентства. Данные нового лида передаются в POST-запросе.

На входе функция принимает следующие данные о лиде:

Результатом выполнения функции является ассоциативный массив:

Пример ответа функции:

{ "status" : "ok", "id" : 1234, "uid" : 123456 }

Проверка статуса лидов

URL: https://my.finasset.ru/api/ext/list.json?id={token}

Функция позволяет получить информацию о статусе обработки отправленных лидов.

На входе функция может использовать следующие параметры для отбора заказов:

Результатом выполнения функции является массив статусов лидов. Ключевой параметр - идентификатор заказа на стороне агентства. Для каждого лида указываются следующие параметры:

Пример ответа функции:

[
 1234 : {
  "id": 1234, // ID заказа на стороне агентства
  "uid": 432, // ID заказа на стороне нашей системы
  "phase": 5, // Код статуса заказа
  "stage": "trash", // Статус заказа
  "reason": 2, // Код причины отказа
  "comment: "Мур-мур-мур-мур", // Комментарий по заказу
 },
 2345 : {
  "id": 2345, // ID заказа на стороне агентства
  "uid": 543, // ID заказа на стороне нашей системы
  "phase": 3, // Код статуса заказа
  "stage": "approved", // Статус заказа
  "count: 2, // Количество товара в заказе
 }
]