Справочный центр
UMcrm
API документация
Как по API передавать заказы в UMcrm
Создание заказа
/api/orders/create
URL: https://b550.umcrm.pro/api/orders/create
Method: POST, GET
Content-Type: application/json
Где b550 - это номер версии вашей CRM (или CRM в которую вы направляете заказы)
ВЛАДЕЛЬЦАМ аккаунта в UMcrm рекомендуем под каждого партнера создавать отдельный UUID!
UUID партнера, генерируется в crm при создании партнера. "Инструменты - Партнеры - Все партнеры"
Для внешних вебмастеров (арбитражников, таргетологов, CPA сетей)
Если вы партнер, который передает заказы в UMcrm, вам нужно запросить у владельца аккаунта CRM следующие данные:

- key (обязательный параметр) - это UUID партнера, Генерируется в crm при создании партнера. "Инструменты - Партнеры - Все партнеры" https://prnt.sc/wfz5c0
- subproject_id (обязательный параметр) -значение поля "External id" проекта созданного в crm "Настройки - Все проекты" https://prnt.sc/wfzbb2
- offer_id (обязательный параметр) - "Внешний ID" идентификатор оффера который можно увидеть на странице редактирования (Настройки - Все офферы - редактировать) https://prnt.sc/wfzduv
- products (обязательный параметр) - Массив товаров которые добавляются в заказ. Администрирование - Продукты,Сервисы - Все продукты https://prnt.sc/wfzgzq

Каждый элемент массива должен иметь обязательные поля:
'id' - id продукта в системе клиента,
'name' - название товара,
'price' - цена товара,
'amount' - количество, если не будет передано заполнится 1,
'sku' - артикул товара

*service (обязательный параметр) - по умолчанию указывайте "all"
Пример:
    {
    "key": "UX3HngYsUpG8NhXuc5RFBuzX7jtH7s",
    "ip": "192.168.10.10",
    "name": "Вася",
    "surname": "Василиев",
    "middle_name": "Васильевич",
    "phone": "79185746977",
    "country": "ru",
    "comment": "Черный",
    "source_url": "source_url",
    "all_price": 13,
    "offer_id": 4,
    "subproject_id": 5652515
    "offer_name": "Bottokan",
    "service": "all",
    "products": [{
        "id": "10",
        "name": "Hair Groves Nano",
        "price": "150",
        "amount": "5",
        "sku": "15483651"
        }
    ],
    "subid1": "1234",
    "subid2": "123214",
    "subid3": "www.test.com",
    "subid4": "54634",
    "subid5": "9783",
    "subid6": "test",
    "subid7": "some text",
    "back_url":"https://www.google.com",
    "back_error_url": "https://www.google.com",
    "external_user_login": '4: test_webmaster',
    'external_source_name': '15: facebook',
    'user_agent': 'Xiaomi_MDT2_TD-LTE/V1 Linux/3.18.31 Android/7.1 Release/5.15.2017 Browser/AppleWebKit537.36 Mobile Safari/537.36 System/Android 7.1 XiaoMi/MiuiBrowser/8.7.7'
}
Коды ответов
422 - error validation
200 - success response
Варианты ответов
{
        "success": false,
        "code": 422,
        "errors": {
            "service": [
                "The selected service is invalid."
            ]
        }
    }
        Ошибка валидации, в частности поле "service" содержит неверные данные, убедитесь что Вы передаете данные которые ожидаются, возможно и другое содержимое массива "errors"
{
        "success": "false",
    }
     Возникла внутренняя ошибка, обратитесь в поддержку
{
        "success": true,
        "order_id": 138208,
    }
     Заказ успешно создан
{
    "success": true,
    "order_id": 72,
    "message": [
        "empty_project",
        "empty_offer"
    ]
}
      Заказ успешно создан, но для него goal не создан по причине:
        "empty_project" - Переданный идентификатор проекта, не зарегистрирован в crm. Проверьте настройки crm "Настройки - Проекты"
        "empty_offer" - Указанный идентификатор оффера, не зарегистрирован в crm. Проверьте настройки crm "Настройки - Офферы"
        "antifraud_blacklist" - Включена Антифрод проверка, или создаваемые заказы попадают в черный список.
        Проверьте настройки Вашей crm "Настройки - Заказы - Антифрод настройки", "Настройки - Заказы - Черный список"
Пример на РНР
if ($curl = curl_init())
    {
       $url = https://b550.umcrm.pro/api/orders/create;
       $content = {
        "key": "UX3HngYsUpG8NhXuc5RFBuzX7jtH7s",
        "ip": "192.168.10.10",
        "name": "Вася",
        "surname": "Василиев",
        "middle_name": "Васильевич",
        "phone": "79185746977",
        "country": "ru",
        "comment": "Черный",
        "source_url": "source_url",
        "all_price": 13,
        "offer_id": 4,
        "subproject_id": 5652515
        "offer_name": "Bottokan",
        "service": "all",
        "products": [{
            "id": "10",
            "name": "Hair Groves Nano",
            "price": "150",
            "amount": "5",
            "sku": "15483651"
            }
        ],
        "subid1": "1234",
        "subid2": "123214",
        "subid3": "www.test.com",
        "subid4": "54634",
        "subid5": "9783",
        "subid6": "test",
        "subid7": "some text",
        "back_url":"https://www.google.com",
        "back_error_url": "https://www.google.com",
        "external_user_login": '4: test_webmaster',
        'external_source_name': '15: facebook',
        'user_agent': 'Xiaomi_MDT2_TD-LTE/V1 Linux/3.18.31 Android/7.1 Release/5.15.2017 Browser/AppleWebKit537.36 Mobile Safari/537.36 System/Android 7.1 XiaoMi/MiuiBrowser/8.7.7'
        };

       curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 60);
       curl_setopt($curl, CURLOPT_URL, $url);
       curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
       curl_setopt($curl, CURLOPT_POST, TRUE);
       curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($content));
       curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
       $response = curl_exec($curl);

       curl_close($curl);

       print_r($response, 1);
    }
Пример запроса методом GET
https://b550.umcrm.pro/api/orders/create?key=UX3HngYcsxcw2&type=goal&id=353055&country=ua&ip=13.13.13.12&all_price=560000.00&offer_id=23&offer_name=AirPod наушники&service=all&name=Иван&surname=Иванович&middle=Иванов&phone=+380950503235&comment=Синийцвет-35размер&project_id=4000&subproject_id=4001&subid1=cat&subid13=vanya&products[0][id]=1323&products[0][name]=testsd22 sd2&products[0][price]=313131311&products[0][amount]=1&subid16=www.test.com&back_url=www.test.com
Проверка статусов заказа
/api/orders/get-status
URL: https://b550.umcrm.pro/api/orders/get-status
Method: POST, GET
Content-Type: application/json
Пример:
{
    "key": "UX3HngYsUpG8NhXuc5RFBuzX7jtH7s",
    "orderIds": "15,20,1504"
}
Варианты ответов:
{
        "success": false,
        "code": 422,
        "errors": {
            "orderIds": [
                "The order ids field is required."
            ]
        }
    }
        common.guide.orders_get_status.error_validation
{
    "success": "false",
    'message': 'no such goals'
}
    common.guide.orders_get_status.no_such_goals
{
    "success": true,
    "data": [
        {
            "id": 1,
            "goal_status_id": 7,
            "goal_status": "canceled",
            "sending_status_id": null,
            "sending_status": ""
        },
        {
            "id": 11,
            "goal_status_id": 5,
            "goal_status": "approved",
            "sending_status_id": 26,
            "sending_status": "new_sending"
        },
        {
            "id": 15,
            "goal_status_id": 6,
            "goal_status": "refusal",
            "sending_status_id": 14,
            "sending_status": "canceled_sent"
        }
    ]
}
    Статусы найденных заказов
Made on
Tilda