Интеграция с сервисом Roistat

Версия v1

                Примечание: Для доступа к методам интеграции необходимо отправлять GET/POST запросы на
                https://newapi.archimed-soft.ru/roistat/v1/php?action={action}&{ПАРАМЕТРЫ}&token={token}
                                

Таблица соответствия методов

Название	Action	Примечание
Метод выгрузки информации о статусах, дополнительных полях и менеджерах CRM-системы	import_scheme	GET запрос
Метод выгрузки информации о сделках из CRM-системы	export	POST запрос
Метод выгрузки информации о клиентах из CRM-системы	export_clients	POST запрос
Метод создания лидов в CRM-системе	lead	POST запрос
Метод добавления комментария к текущей сделке	message	GET запрос

Метод	GET
Параметры
Название параметра	Описание	Обязательно
action	import_scheme	Да
user	Имя пользователя в CRM	Нет
token	Токен клиента	Да

https://newapi.archimed-soft.ru/roistat/v1/php?user=test_user&action=import_scheme&token=ZmVjNTc1NDIyYTdlNzkyNDg3ZTc5ODY0NGQwMGJmNGE

В ответ на запрос Вы получите ответ в формате JSON:

{
    "statuses": [
        {
            "id": "1",
            "name": "Уточнить расписание"
        },
        {
            "id": "2",
            "name": "Записаться на прием к врачу"
        }
    ],
    "fields": [
        {
            "id": "1",
            "name": "поле 1"
        }
    ],
    "managers": [
        {
            "id": "1",
            "name": "Администратор ArchiMed+  ",
            "phone": ""
        }
    ]
}

Метод	POST
Параметры
Название параметра	Описание	Обязательно
action	export	Да
date	Дата в формате UNIX-time, после которой были изменения в сделках	Да
limit	Количество выгружаемых клиентов	Нет
offset	Количество клиентов от начала выборки	Нет
user	Имя пользователя в CRM	Нет
token	токен клиента	Да

https://newapi.archimed-soft.ru/roistat/v1/php?action=export&date=1546300800&limit=1000&offset=0&user=test_user&token=ZmVjNTc1NDIyYTdlNzkyNDg3ZTc5ODY0NGQwMGJmNGE

В ответ на запрос Вы получите ответ в формате JSON:

{
    "pagination": {
        "total_count": 32,
        "limit": 3,
        "offset": 0
    },
    "orders": [
        {
            "id": "1",
            "date_create": 1582635720,
            "status": "0",
            "price": "0.0",
            "roistat": "",
            "client_id": "2",
            "manager_id": "1",
            "fields": {
                "1": "рппрпр",
                "2": "кеппр"
            }
        },
        {
            "id": "2",
            "date_create": 1583858880,
            "status": "0",
            "price": "0.0",
            "roistat": "",
            "client_id": "2",
            "manager_id": "1",
            "fields": {
                "1": "ысыс",
                "2": "ыы"
            }
        },
        {
            "id": "9",
            "date_create": 1591199100,
            "status": "0",
            "price": "0.0",
            "roistat": "12345",
            "client_id": "0",
            "manager_id": "1",
            "fields": {}
        }
    ]
}

Метод	POST
Параметры
Название параметра	Описание	Обязательно
action	export_clients	Да
date	Дата в формате UNIX-time, после которой были изменения в сделках	Да
limit	Количество выгружаемых клиентов	Нет
offset	Количество клиентов от начала выборки	Нет
user	Имя пользователя в CRM	Нет
token	Токен клиента	Да

https://newapi.archimed-soft.ru/roistat/v1/php?action=export_clients&date=1546300800&limit=100&offset=0&user=test_user&token=ZmVjNTc1NDIyYTdlNzkyNDg3ZTc5ODY0NGQwMGJmNGE

В ответ на запрос Вы получите ответ в формате JSON:

{
    "pagination": {
        "total_count": 5,
        "limit": 2,
        "offset": 0
    },
    "clients": [
        {
            "id": "2",
            "name": "Иванов Сергей Анатольевич",
            "phone": "7953256544",
            "email": "",
            "company": "ООО \"Агропроммаш\"",
            "birth_date": "1967-12-23"
        },
        {
            "id": "3",
            "name": "Литвинова Олеся Эдгаровна",
            "phone": "89555555555",
            "email": "example@ex.ru",
            "company": "ООО \"Агропроммаш\"",
            "birth_date": "1985-12-23"
        }
    ]
}

Метод	POST
Параметры
Название параметра	Описание	Обязательно
action	lead	Да
user	Имя пользователя в CRM	Нет
token	Токен клиента	Да
created_date	(POST) Дата создания - YYYY-MM-DD HH:MM:SS	Нет
data	(POST) JSON дополнительных полей заявки. В том числе поля roistat, где содержится номер визита	Нет
email	(POST) Email адрес клиента, оставившего заявку	Нет
manager_id	(POST) Ответственный менеджер, который указан на этапе “отправка данных в CRM”	Да
name	(POST) Имя клиента, оставившего заявку	Нет
phone	(POST) Номер телефона клиента, оставившего заявку	Да
text	(POST) Комментарий заявки, содержащий дополнительную информацию	Нет

https://newapi.archimed-soft.ru/roistat/v1/php?action=lead&user=test_user&token=ZmVjNTc1NDIyYTdlNzkyNDg3ZTc5ODY0NGQwMGJmNGE

Body:

{
    "created_date": "YYYY-MM-DD HH:MM:SS",
    "data": {
        "roistat": "12345",
        "custom_field": "value"
    },
    "email": "new@mail.com",
    "name": "Name",
    "phone": "79056660012",
    "text": "Новый заказ с сайта",
    "title": "Заказ с сайта",
    "visit": "12345",
    "manager_id": 1
}

В ответ на запрос Вы получите ответ в формате JSON:

{
    "status": "ok",
    "order_id": "49"
}

Метод	GET
Параметры
Название параметра	Описание	Обязательно
action	message	Да
leadId	ID сделки или иной сущности, в которую необходимо добавить сообщение	Да
title	Заголовок сообщения	Нет
message	Текст сообщения	Да
user	Имя пользователя в CRM	Нет
token	Токен клиента	Да

https://newapi.archimed-soft.ru/roistat/v1/php?action=message&leadId=12345&title=Заголовок сообщения&message=Текст&user=test_user&token=ZmVjNTc1NDIyYTdlNzkyNDg3ZTc5ODY0NGQwMGJmNGE

В ответ на запрос Вы получите ответ в формате JSON:

{
    "status": "ok"
}