API поставщика

Чтобы начать работу с API-интерфейсом, необходимо получить ID и ключ. Они доступны в разделе «Профиль». Далее по тексту пользовательский ID будет обозначаться {user}, а ключ доступа - {key}. Важно! В строке запроса фигурные скобки указывать не нужно!

Взаимодействие с сервисом осуществляется по протоколу HTTP. Формат запроса - чистый POST. Формат результата - JSON. Ограничений на количество запросов нет. Если вам требуется отправить запрос в виде JSON POST, не забудьте указать заголовок Content-type: application/json

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

URL: https://api.cpa.moe/comp/add.json?id={user}-{key}

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

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

Дополнительные параметры для создания лида:

Пример простого запроса на создание лида (показан в JSON для удобства):

{
    "offer": 217,
    "ip": "12.34.56.78",
    "name": "John Doe",
    "phone": "77000000000",
    "country": "kz",
}

Пример создания лида с указанием массива товаров (показан в JSON для удобства):

{
    "offer": 217,
    "ip": "12.34.56.78",
    "name": "Jane Doe",
    "phone": "79000000000",
    "country": "ru",
    "items": [
        {
            "id": 135,
            "price": 9900,
            "count": 1
        }
    ]
}

Пример создания лида с произвольными полями (показан в JSON для удобства)

{
    "offer": 217,
    "ip": "12.34.56.78",
    "name": "John",
    "phone": "77000000000",
    "country": "kz",
    "params": {
        "sirname": "Doe",
        "phonecc": "+7"		
    }
}

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

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

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

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

URL: https://api.cpa.moe/comp/list.json?id={user}-{key}&oid=1,2,3

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

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

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

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

[
    {
        "id": 13131,
        "offer": 15,
        "offername": "Shiny test offer",
        "wm": 59,
        "stage": "approve",
        "phase": 3,
        "status": 8,
        "reason": 0,
        "ip": "12.34.56.78",
        "time": 1234567890,
        "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://api.cpa.moe/comp/status.json?id={user}-{key}&oid=123&status=approve

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

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

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

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

{ "status" : "ok" }

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

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

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

URL: https://api.cpa.moe/comp/edit.json?id={user}-{key}

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

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

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

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

{ "status" : "ok" }

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

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

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

URL: https://api.cpa.moe/comp/stats.json?id={user}-{key}&item=date

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

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

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

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

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

Добавление аудио записи звонка

URL: https://api.cpa.moe/comp/audio.json?id={user}-{key}

Чтобы прикрепить запись звонка к заказу, обязательно потребуется URL самой записи и номер телефона, на который осуществлялся звонок. Номер телефона должен совпадать с указанным в самом заказе. Крайне желательно также указывать время совершения звонка и исходящий номер звонящего, указанный у него в профиле. Конкретные ИД заказа и ИД изменения система постарается определить автоматически. Если есть возможность указать ИД заказа - будет только лучше.

Параметры могут передаваться как в GET, так и в POST.

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

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

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

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

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