Перейти к содержанию

Клиенты

Авторизация

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

Номер проекта можно передавать в URL запроса, например: https://cloud.roistat.com/api/v1/project/clients/import?project=12345

API-ключ можно передавать двумя способами:

  • Устанавливая HTTP-заголовок Api-key(рекомендуемый способ):

    Api-key: 1234567890qwerty
    
  • Добавляя параметр key в URL запроса (небезопасный способ):

    https://cloud.roistat.com/api/v1/project/clients/import?key=1234567890qwerty&project=12345
    

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

POST /project/clients/import

Данный метод необходим для создания или обновления клиентов.

Строка запроса:

POST https://cloud.roistat.com/api/v1/project/clients/import?project=12345

Тело запроса:

[
    {
        "id": "111",
        "name": "Валера",
        "phone": "78888888888",
        "email": "email1@mail.com",
        "company": "company1",
        "birth_date": "1980-01-01"
    },
    {
        "id": "222",
        "name": "Ваcилий",
        "phone": "79999999999",
        "email": "email2@mail.com",
        "company": "company2",
        "birth_date": "1990-01-01"
    }
]
{
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
id string ID клиента в CRM нет
name string имя клиента нет
phone null или string номер телефона клиента (должен быть указан или телефонный номер клиента, или email) нет
email null или string адрес электронной почты клиента (должен быть указан или телефонный номер клиента, или email) нет
company null или string название компании клиента нет
birth_date null или string дата рождения клиента нет
Параметр Тип Описание Обязательный
status string нет

Получить список клиентов из Управления клиентами

POST /project/clients

Данный метод позволяет получить список клиентов из Управления клиентами.

Строка запроса:

POST https://cloud.roistat.com/api/v1/project/clients?project=12345

Тело запроса:

{
    "filters": [
        [
            "phone",
            "=",
            "79880002233"
        ]
    ],
    "limit": 100,
    "offset": 0
}
{
    "clients": [
        {
            "id": 7,
            "first_visit_date": null,
            "external_id": "105",
            "name": "Имя клиента",
            "phone": "79880002233",
            "email": "test@roistat.test",
            "first_order_date": null,
            "last_order_date": null,
            "order_count": 0,
            "revenue": 0,
            "profit": 0,
            "birth_date": null,
            "company": "",
            "comment": null,
            "client_url": "http://example.crm.com/contacts/105",
            "first_visit_marker": null,
            "first_visit_marker_alias": "",
            "first_visit_marker_icon": "https://cloud.roistat.com/img/arrow-right.png",
            "first_visit_marker_alias_level_1": ""
        },
        {
            "id": 6,
            "first_visit_date": null,
            "external_id": "106",
            "name": "Иван",
            "phone": "79880002233",
            "email": "test@roistat.test",
            "first_order_date": null,
            "last_order_date": null,
            "order_count": 0,
            "revenue": 0,
            "profit": 0,
            "birth_date": null,
            "company": "",
            "comment": null,
            "client_url": "http://example.crm.com/contacts/106",
            "first_visit_marker": null,
            "first_visit_marker_alias": "",
            "first_visit_marker_icon": "https://cloud.roistat.com/img/arrow-right.png",
            "first_visit_marker_alias_level_1": ""
        }
    ],
    "total": 2,
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
filters object нет
and array[string] нет
limit integer нет
offset integer нет
Параметр Тип Описание Обязательный
clients array[object] нет
object нет
>> id integer ID клиента в Roistat нет
>> first_visit_date string или null дата первого визита нет
>> external_id string ID клиента в CRM нет
>> name string имя клиента нет
>> phone string телефон клиента нет
>> email string емейл клиента нет
>> first_order_date string или null дата первого заказа нет
>> last_order_date string или null дата последнего заказа нет
>> order_count integer количество заказов нет
>> revenue integer выручка по заказам нет
>> profit integer прибыль по заказам нет
>> birth_date string или null дата дня рождения нет
>> company string компания клиента нет
>> comment string или null нет
>> client_url string URL клиента в CRM нет
>> first_visit_marker string или null нет
>> first_visit_marker_alias string нет
>> first_visit_marker_icon string нет
>> first_visit_marker_alias_level_1 string нет
total integer нет
status string нет