Клиенты

  Одна из основных сущностей системы. Сотоит из набора основных и дополнительных полей. Каждый клиент может участвовать в одной или нексольких сделках, а может быть не привязан ни к одной. Каждому клиенту может быть задан ответственный для разграничения прав доступа между сотрудниками аккаунта.

Создание клиентов

Создаёт одного или нескольких клиентов.

 

Запрос

POST https://api.megacrm.ru/v1/clients

Тело запроса представляет из себя список объектов клиентов:

Название параметра

Обязательный

Тип и ограничения

Описание

name

Да

Строка не более 200 символов

Имя клиента или название организации

type

 

Целое число

Значение по умолчанию зависит от настройки "Тип клиента по умолчанию"

category_id

 

Натуральное число

ID категории

doer_id

 

Натуральное число

ID ответственного

source_id

 

Натуральное число

ID источника

last_name

 

Строка не более 50 символов

Фамилия

patronymic

 

Строка не более 50 символов

Отчество

gender

 

Натуральное число

Пол:

1 — муж

2 — жен

description

 

Строка не более 1000 символов

Описание

deleted

 

Логический

Клиент удалён

custom_fields

 

Список из объектов дополнительных полей

Значения дополнительных полей

tags

 

Список из натуральных чисел и строк

Список меток:

натуральное число — ID метки;

строка — название метки

 

 

Ответ

Ответ содержит список ID созданных клиентов.

 

 

Пример

POST http://api.megacrm.ru/v1/clients
Content-Type: application/json
X-MegaCrm-ApiAccount: 12345678
X-MegaCrm-ApiSignature: abcdef0123456789

[
  {
    "name": "Игорь",
    "type": 0,
    "doer_id": 123456,
    "last_name": "Печки",
    "patronymic": "Иванович",
    "gender": 1,
    "tags": [
      "Хочет велосипед"
    ],
    "custom_fields": [
      {
        "id": 1,
        "values": [
          "Усы, лапы, хвост"
        ]
      }
    ]
  }
]

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8

{
  "result": [
    32
  ]
}

Изменение клиентов

Изменяет одного или нескольких клиентов.

 

Запрос

PATCH https://api.megacrm.ru/v1/clients

Тело запроса представляет из себя список объектов клиентов:

Название параметра

Обязательный

Тип и ограничения

Описание

id

Да

Натуральное число

ID клиента

name

 

Строка не более 200 символов

Имя клиента или название организации

type

 

Целое число

Тип клиента:

0 — физ. лицо

1 — юр. лицо

category_id

 

Натуральное число

ID категории

doer_id

 

Натуральное число

ID ответственного

source_id

 

Натуральное число

ID источника

last_name

 

Строка не более 50 символов

Фамилия

patronymic

 

Строка не более 50 символов

Отчество

gender

 

Натуральное число

Пол:

1 — муж

2 — жен

description

 

Строка не более 1000 символов

Описание

deleted

 

Логический

Клиент удалён

custom_fields

 

Список из объектов дополнительных полей

Значения дополнительных полей

tags

 

Список из натуральных чисел и строк

Список меток:

натуральное число — ID метки;

строка — название метки

 

 

Ответ

Ответ содержит список ID изменённых клиентов.

 

 

Пример

GET https://api.megacrm.ru/v1/clients?query=Печкин
X-MegaCrm-ApiAccount: 12345678
X-MegaCrm-ApiSignature: abcdef0123456789

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8

{
  "result": [
    {
      "id": 32,
      "ui_id": 32,
      "creator_id": 0,
      "doer_id": 123456,
      "name": "Игорь",
      "last_name": "Печкин",
      "patronymic": "Иванович",
      "gender": 1,
      "type": 0,
      "description": "",
      "created": 252450000,
      "updated": 252450000,
      "deleted": false,
      "category": {
        "id": 1,
        "name": "Клиент",
        "position": 0,
        "deletable": true
      },
      "source": null,
      "tags": [
        {
          "id": 1,
          "name": "Хочет велосипед",
          "position": 0,
          "bg_color": "#000000",
          "deleted": false
        }
      ],
      "custom_fields": [
        {
          "id": 1,
          "values": [
            {
              "displayValue": "Усы, лапы, хвост",
              "value": "Усы, лапы, хвост"
            }
          ]
        }
      ]
    }
  ]
}

Поиск клиентов

Находит клиентов.

 

Запрос

GET https://api.megacrm.ru/v1/clients

Название параметра

Обязательный

Тип и ограничения

Описание

id

 

Натуральное число или список из натуральных чисел, не более 500 шт

ID сделки или нескольких сделок.

Если этот параметр указан, все остальные игнорируются

query

 

Строка

Поиск по текстовым полям

category_id

 

Натуральное число или список из натуральных чисел

ID категории

doer_id

 

Натуральное число или список из натуральных чисел

ID ответственного

source_id

 

Натуральное число или список из натуральных чисел

ID источника

tag_id

 

Натуральное число или список из натуральных чисел

ID метки

type

 

Целое число

Тип клиента:

0 — физ. лицо

1 — юр. лицо

custom_fields

 

Массив значений дополнительных полей

Значения дополнительных полей.

Ключ массива — ID дополнительного поля. Значение массива — искомое значение или объект диапазона значений.

page

 

Натуральное число

Страница

limit

 

Натуральное число не более 500.

По умолчанию 100

Количество элементов на странице

 

 

Ответ

Ответ содержит параметр «result», в котором находится список объектов клиента:

Название параметра

Тип

Описание

id

Натуральное число

ID клиента

ui_id

Натуральное число

Номер клиента

creator_id

Натуральное число

ID пользователя, создавшего клиента. Может отсутствовать, если клиент создан без участия пользователя

doer_id

Натуральное число

ID ответственного

name

Строка

Имя клиента или название организации

last_name

Строка

Фамилия

patronymic

Строка

Отчество

gender

Целое число

Пол:

1 — муж

2 — жен

type

Целое число

Тип клиента:

0 — физ. лицо

1 — юр. лицо

description

Строка

Описание

created

Время в unix timestamp

Время создания клиента

updated

Время в unix timestamp

Время последнего изменения клиента

deleted

Логический

Клиент удалён

category

Объект категории клиента

Категория клиента

source

Объект источника клиента

Источник клиента

tags

Список объектов меток

Метки

custom_fields

Список объектов значений доп. полей

Значения дополнительных полей

 

 

Пример

GET https://api.megacrm.ru/v1/clients?query=Печкин
X-MegaCrm-ApiAccount: 12345678
X-MegaCrm-ApiSignature: abcdef0123456789

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8

{
  "result": [
    {
      "id": 32,
      "ui_id": 32,
      "creator_id": 0,
      "doer_id": 123456,
      "name": "Игорь",
      "last_name": "Печкин",
      "patronymic": "Иванович",
      "gender": 1,
      "type": 0,
      "description": "",
      "created": 252450000,
      "updated": 252450000,
      "deleted": false,
      "category": {
        "id": 1,
        "name": "Клиент",
        "position": 0,
        "deletable": true
      },
      "source": null,
      "tags": [
        {
          "id": 1,
          "name": "Хочет велосипед",
          "position": 0,
          "bg_color": "#000000",
          "deleted": false
        }
      ],
      "custom_fields": [
        {
          "id": 1,
          "alias": "code",
          "values": [
            {
              "displayValue": "Усы, лапы, хвост",
              "value": "Усы, лапы, хвост"
            }
          ]
        }
      ]
    }
  ]
}

Получение клиента

Получает одного клиента.

 

Запрос

GET http://api.megacrm.ru/v1/clients/<ID клиента>

 

 

Ответ

Ответ содержит объект клиента:

Название параметра

Тип

Описание

id

Натуральное число

ID клиента

ui_id

Натуральное число

Номер клиента

creator_id

Натуральное число

ID пользователя, создавшего клиента. Может отсутствовать, если клиент создан без участия пользователя

doer_id

Натуральное число

ID ответственного

name

Строка

Имя клиента или название организации

last_name

Строка

Фамилия

patronymic

Строка

Отчество

gender

Целое число

Пол:

1 — муж

2 — жен

type

Целое число

Тип клиента:

0 — физ. лицо

1 — юр. лицо

description

Строка

Описание

created

Время в unix timestamp

Время создания клиента

updated

Время в unix timestamp

Время последнего изменения клиента

deleted

Логический

Клиент удалён

category

Объект категории клиента

Категория клиента

source

Объект источника клиента

Источник клиента

tags

Список объектов меток

Метки

custom_fields

Список объектов значений доп. полей

Значения дополнительных полей

 

Пример

GET https://api.megacrm.ru/v1/clients/32
X-MegaCrm-ApiAccount: 12345678
X-MegaCrm-ApiSignature: abcdef0123456789

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8

{
  "result": {
    "id": 32,
    "ui_id": 32,
    "creator_id": 0,
    "doer_id": 123456,
    "name": "Игорь",
    "last_name": "Печкин",
    "patronymic": "Иванович",
    "gender": 1,
    "type": 0,
    "description": "",
    "created": 252450000,
    "updated": 252450000,
    "deleted": false,
    "category": {
      "id": 1,
      "name": "Клиент",
      "position": 0,
      "deletable": true
    },
    "source": null,
    "tags": [
      {
        "id": 1,
        "name": "Хочет велосипед",
        "position": 0,
        "bg_color": "#000000",
        "deleted": false
      }
    ],
    "custom_fields": [
      {
        "id": 1,
        "alias": "code",
        "values": [
          {
            "displayValue": "Усы, лапы, хвост",
            "value": "Усы, лапы, хвост"
          }
        ]
      }
    ]
  }
}

Список категорий

Получает список категорий клиентов.

 

Запрос

GET http://api.megacrm.ru/v1/clients/categories

 

 

Ответ

Ответ содержит параметр «result», в котором находится список объектов категорий:

Название параметра

Тип

Описание

id

Натуральное число

ID категории

name

Строка

Название

position

Целое число

Порядок следования категории в общем списке

deletable

Логический

Категорию можно удалить

 

 

Пример

GET https://api.megacrm.ru/v1/clients/categories
X-MegaCrm-ApiAccount: 12345678
X-MegaCrm-ApiSignature: 2fce06d7dc0d7e32a5c900a05b51a105a7b595510ca77c54a1720b625353553d

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8

{
  "result": [
    {
      "id": 1,
      "name": "Клиент",
      "position": 0,
      "deletable": false
    },
    {
      "id": 2,
      "name": "Партнер",
      "position": 2,
      "deletable": true
    },
    {
      "id": 3,
      "name": "Конкурент",
      "position": 1,
      "deletable": true
    }
  ]
}

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

Получает список источников клиентов.

 

Запрос

GET http://api.megacrm.ru/v1/clients/sources

 

 

Ответ

Ответ содержит параметр «result», в котором находится список объектов источников:

Название параметра

Тип

Описание

id

Натуральное число

ID источника

name

Строка

Название

 

 

Пример

GET https://api.megacrm.ru/v1/clients/sources
X-MegaCrm-ApiAccount: 12345678
X-MegaCrm-ApiSignature: 2250e9614f93b0ed62dc5ca949e4884c8711f3bcf879c4cdb424035a8a2df771

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8

{
  "result": [
    {
      "id": 1,
      "name": "Поисковая система"
    },
    {
      "id": 2,
      "name": "Онлайн маркетинг"
    },
    {
      "id": 3,
      "name": "Офлайн маркетинг"
    },
    {
      "id": 4,
      "name": "Рекомендация знакомых"
    },
    {
      "id": 5,
      "name": "Соц.сеть"
    },
    {
      "id": 6,
      "name": "Рассылка"
    }
  ]
}

Список меток

Получает список меток клиентов.

 

Запрос

GET http://api.megacrm.ru/v1/clients/tags

 

 

Ответ

Ответ содержит параметр «result», в котором находится список объектов меток:

Название параметра

Тип

Описание

id

Натуральное число

ID метки

name

Строка

Название

position

Целое число

Порядок следования метки в общем списке

bg_color

Строка

Фоновый цвет в формате #RRGGBB

deleted

Логический

Метка удалена

 

 

Пример

GET https://api.megacrm.ru/v1/clients/tags
X-MegaCrm-ApiAccount: 12345678
X-MegaCrm-ApiSignature: f82ec107708d6b362bb51493dc9b642583a67129ca50e36db8461343d795333f

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8

{
  "result": [
    {
      "id": 1,
      "name": "Хочет велосипед",
      "position": 1,
      "bg_color": "#dd8888",
      "deleted": false
    }
  ]
}
Была ли статья вам полезна?
Укажите, пожалуйста, почему?
Комментарий