Обновлено 30 мая 2021 г.

Проекты

GET Проекты

Возвращает проекты со всеми динамическими полями.

count uint – количество объектов;

offset uint – смещение выборки;

order_by string – поле сортировки;

reverse string – сортировка "0" - по возрастанию; "1" - по убыванию;

deleted string – "0" - активные объекты; "1" - удаленные объекты.


curl --location --request GET 'https://{YOUR_CRM_URL}/backend/public/projects?count=100&offset=0&order_by=id&reverse=0&deleted=0' \
--header 'X-Crypto-Token: {YOUR_CRM_TOKEN}' \
--header 'X-Crypto-Secret: {YOUR_CRM_SECRET}' \

POST Фильтр проектов

count uint – количество объектов;

offset uint – смещение выборки;

order_by string – поле сортировки;

reverse string – сортировка "0" - по возрастанию; "1" - по убыванию;

deleted string – "0" - активные объекты; "1" - удаленные объекты;

condition string – условие выборки "and" - выполнение всех условий; "or" - выполнение одного из условий;

having string – дополнительные условия выборки:

"actions" - Есть события
"payments" - Есть платежи
"tasks" - Есть задачи
"goods" - Есть товары
"no_actions" - Нет событий
"no_payments" - Нет платежей
"no_tasks" - Нет задач
"no_goods" - Нет товаров
"checklists_expired" - Просрочен чек-лист

buildin_data object – встроенные поля;

data object – динамические поля.


curl --location --request POST 'https://{YOUR_CRM_URL}/backend/public/projects/filter' \
--header 'Content-Type: application/json' \
--header 'X-Crypto-Token: {YOUR_CRM_TOKEN}' \
--header 'X-Crypto-Secret: {YOUR_CRM_SECRET}' \
--data-raw '{
    "count": 100,
    "offset": 0,
    "order_by": "id",
    "reverse": "0",
    "deleted": "0",
    "condition": "and",
    "having": "checklists_expired",
    "buildin_data": {
        "created": "2020-01-01;2020-12-31",
        "sales_funnel_id": [
            1,
            2
        ],
        "step_id": [
            1,
            2,
            3,
            4,
            5
        ],
        "user_id": [
            2,
            4,
            6,
            8
        ],
        "group_id": [
            1,
            2,
            3
        ],
        "price": 100,
        "currency_id": [
            1,
            2,
            3
        ],
        "participants_user_id": [
            1,
            2,
            4,
            5,
            7,
            8
        ],
        "participants_group_id": [
            1,
            2,
            4,
            5,
            7,
            8
        ],
        "actions_type_id": [
            1,
            2,
            3
        ],
        "good_id": [
            10,
            11,
            12
        ]
    },
    "data": {
        "client_id": [
            1,
            3
        ],
        "contract_date": "2020-01-01"
    }
}'

GET Проект

Информация о проекте.

id uint – ID проекта.


curl --location --request GET 'https://{YOUR_CRM_URL}/backend/public/projects/info?id=1' \
--header 'X-Crypto-Token: {YOUR_CRM_TOKEN}' \
--header 'X-Crypto-Secret: {YOUR_CRM_SECRET}' \

GET Этапы проекта

Возвращает информацию об этапах проекта.

id uint – ID проекта;

filter_date SQL DATE – фильтр по дате;

filter_steps string – фильтр по ID этапа проекта (разделяются символом нижнего подчеркивания).


curl --location --request GET 'https://{YOUR_CRM_URL}/backend/public/projects/steps?id=1&filter_date=2021-05-21&filter_steps=1_2_3_4_5' \
--header 'X-Crypto-Token: {YOUR_CRM_TOKEN}' \
--header 'X-Crypto-Secret: {YOUR_CRM_SECRET}' \

GET События проекта

Возвращает информацию о событиях проекта.

id uint – ID проекта;

count uint – количество объектов;

offset uint – смещение выборки;

filter_id uint – фильтр по ID события;

filter_date SQL DATE – фильтр по дате;

filter_actions string – фильтр по ID типа события проекта (разделяются символом нижнего подчеркивания).


curl --location --request GET 'https://{YOUR_CRM_URL}/backend/public/projects/actions?id=1&count=100&offset=0&filter_id=1&filter_date=2021-05-21&filter_actions=1_2_3_4_5' \
--header 'X-Crypto-Token: {YOUR_CRM_TOKEN}' \
--header 'X-Crypto-Secret: {YOUR_CRM_SECRET}' \

GET Событие проекта

Информация о событии проекта.

id uint – ID события.


curl --location --request GET 'https://{YOUR_CRM_URL}/backend/public/projects/actions/info?id=1' \
--header 'X-Crypto-Token: {YOUR_CRM_TOKEN}' \
--header 'X-Crypto-Secret: {YOUR_CRM_SECRET}' \

GET Чек-лист проекта

Возвращает информацию о чек-листах проекта.

id uint – ID проекта;


curl --location --request GET 'https://{YOUR_CRM_URL}/backend/public/projects/checklists?id=1' \
--header 'X-Crypto-Token: {YOUR_CRM_TOKEN}' \
--header 'X-Crypto-Secret: {YOUR_CRM_SECRET}' \

GET Товары проекта

Возвращает информацию о товарах проекта.

id uint – ID проекта.


curl --location --request GET 'https://{YOUR_CRM_URL}/backend/public/projects/goods?id=1' \
--header 'X-Crypto-Token: {YOUR_CRM_TOKEN}' \
--header 'X-Crypto-Secret: {YOUR_CRM_SECRET}' \

GET Платежи проекта

Возвращает информацию о платежах проекта.

id uint – ID проекта;

count uint – количество объектов;

offset uint – смещение выборки;

filter_id uint – фильтр по ID платежа;

filter_date SQL DATE – фильтр по дате;

filter_type string – тип платежа "0" - списание; "1" - поступление.


curl --location --request GET 'https://{YOUR_CRM_URL}/backend/public/projects/payments?id=1&count=100&offset=0&filter_id=1&filter_date=2021-05-21&filter_type=1' \
--header 'X-Crypto-Token: {YOUR_CRM_TOKEN}' \
--header 'X-Crypto-Secret: {YOUR_CRM_SECRET}' \