Документация API

8 (800) 551 66 32

Бесплатно по России

Авторизация

POST http://{idcrm}-crm-api.vionvi.com/oauth/token

Параметры запроса

Параметр	Тип данных	Описание
client_id	string	ID интеграции (Выдаётся разработчику по запросу)
client_secret	string	Секретный ключ интеграции
grant_type	string	Тип авторизационных данных (password)
username	string	Логин (Email) аккаунта администратора CRM
password	string	Пароль от аккаунта администратора CRM

Пример запроса:

POST /oauth/token HTTP/1.1
Host: 1-crm-api.vionvi.com
Accept: application/json
Content-Type: application/json
Content-Length: 182

{
"client_id": "xxxxxx",
"client_secret": "xjkfkgjhdfkjhvkdjfhkjvfkjdvfdvfdv",
"grant_type": "xxxxxxxxxx",
"username": "xxxxxxxxxxx",
"password": "xxxxxxxxx"
}

Параметры ответа

Параметр

Тип данных

Описание

token_type

string

Тип токена

expires_in

int

Через сколько истекает токен

access_token

string

Access Token

refresh_token

string

Refresh Token

Пример ответа:

HTTP/1.1200 OK
Server: nginx/1.21.6
Content-Type: application/json; charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
X-Powered-By: PHP/8.1.3
pragma: no-cache
Cache-Control: no-store, private
Date: Tue, 26 Jul 2022 10:29:13 GMT
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 57
Access-Control-Allow-Origin: *

{
"token_type":"Bearer",
"expires_in":31536000,
"access_token":"1NiJ9.eyJhdWQiOiIyIiwianRpIjoiMThjmMyOGE5YzM2OW",
"refresh_token":"def502001d1c2856c5fcfc83e1b51"
}

Создать лид

POST http://{idcrm}-crm-api.vionvi.com/lead

Параметры запроса

Параметр	Тип данных	Описание	Обязательно
name	string	Имя лида	Да
phone	string	Телефон лида	Да
email	string	Email лида	Нет
userIdOwner	int	ID Ответственного сотрудника	Нет
sourceId	int	ID рекламного источника	Нет

При выполнении запроса Access Token необходимо поместить в заголовки (ключ Authorization с указанием типа Bearer), а в теле запроса указать все необходимые параметры метода. При этом не забудьте, что сервер ожидает перечисление параметров в формате JSON, кодировке UTF-8

Пример запроса:
POST/leadHTTP/1.1
Authorization: Bearer ezI1NiJ9.eyJhdWQiOiIyIiwianRpIjoiNGNhMTgwMDczM2
Host: 1-crm-api.vionvi.com
Accept: application/json
Content-Type: application/json
Content-Length: 143

{
"name": "test",
"sourceId": 8,
"phone": 79998888888,
"email": "fff@mail.ru",
"userIdOwner": 1
}

Параметры ответа

Параметр

Тип данных

Описание

id

int

ID созданного лида

name

string

Имя созданного лида

phone

string

Телефон созданного лида

email

string

Email созданного лида

Мы используем обычные коды ответов HTTP для обозначения результата выполнения запроса.
Ответ от сервера приходит в формате JSON и кодировке UTF-8.
При успешном ответе возвращаемый сервером результат будет представлен в теле ответа массивом data.
При ошибке выполнения запроса вы можете получить в теле ответа массив errors

Пример ответа:

HTTP/1.1201 Created
Server: nginx/1.21.6
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
X-Powered-By: PHP/8.1.3
Cache-Control: no-cache, private
Date: Tue, 26 Jul 2022 10:18:12 GMT
X-RateLimit-Limit: 100000
X-RateLimit-Remaining: 99999
Access-Control-Allow-Origin: *

{"data":{"id":16,"name":"test","sourceId":8,"contractId":null,"phone":"79998888888","email":"fff@mail.ru","commentDelete":null,"notAnswer":null,"userIdCreate":1,"userIdUpdate":null,"userIdDelete":null,"dtCreate":"2022-07-26T10:18:12.000000Z","dtUpdate":"2022-07-26T10:18:12.000000Z","dtDelete":null,"dtNotAnswer":null,"status":null,"locationUnitId":null,"userIdOwner":"1"},"success":true}

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

POST http://{idcrm}-crm-api.vionvi.com/client

Параметры запроса

Параметр	Тип данных	Описание	Обязательно
surname	string	Фамилия клиента	Нет
firstName	string	Имя клиента	Да
patronymic	string	Отчество клиента	Нет
phone	string	Телефон клиента	Да
email	string	Email клиента	Нет
dob	date	Дата рождения	Нет

При выполнении запроса Access Token необходимо поместить в заголовки (ключ Authorization с указанием типа Bearer), а в теле запроса указать все необходимые параметры метода. При этом не забудьте, что сервер ожидает перечисление параметров в формате JSON, кодировке UTF-8

Пример запроса:
POST/clientHTTP/1.1
Authorization: Bearer ezI1NiJ9.eyJhdWQiOiIyIiwianRpIjoiNGNhMTgwMDczM2
Host: 1-crm-api.vionvi.com
Accept: application/json
Content-Type: application/json
Content-Length: 143

{
"firstName": "test",
"phone": 79998888888,
"email": "fff@mail.ru",
}

Параметры ответа

Параметр

Тип данных

Описание

id

int

ID созданного клиента

surname

string

Фамилия созданного клиента

firstName

string

Имя созданного клиента

patronymic

string

Отчество созданного клиента

phone

string

Телефон созданного клиента

email

string

Email созданного клиента

dob

Дата рождения клиента

Мы используем обычные коды ответов HTTP для обозначения результата выполнения запроса.
Ответ от сервера приходит в формате JSON и кодировке UTF-8.
При успешном ответе возвращаемый сервером результат будет представлен в теле ответа массивом data.
При ошибке выполнения запроса вы можете получить в теле ответа массив errors

Создать организацию

POST http://{idcrm}-crm-api.vionvi.com/org/client

Параметры запроса

Параметр	Тип данных	Описание	Обязательно
name	string	Название организации	Да
inn	int	ИНН организации	Нет
kpp	int	КПП организации	Нет
ogrn	int	ОРГН организации	Нет
adress	string	Адрес организации	Нет
addressLegal	string	Юр. адрес организации	Нет

При выполнении запроса Access Token необходимо поместить в заголовки (ключ Authorization с указанием типа Bearer), а в теле запроса указать все необходимые параметры метода. При этом не забудьте, что сервер ожидает перечисление параметров в формате JSON, кодировке UTF-8

Пример запроса:
POST/org/clientHTTP/1.1
Authorization: Bearer ezI1NiJ9.eyJhdWQiOiIyIiwianRpIjoiNGNhMTgwMDczM2
Host: 1-crm-api.vionvi.com
Accept: application/json
Content-Type: application/json
Content-Length: 143

{
"name": "Моя компания",
"inn": 1234567891099
}

Параметры ответа

Мы используем обычные коды ответов HTTP для обозначения результата выполнения запроса.
Ответ от сервера приходит в формате JSON и кодировке UTF-8.
При успешном ответе возвращаемый сервером результат будет представлен в теле ответа массивом data.
При ошибке выполнения запроса вы можете получить в теле ответа массив errors

Создать сделку

POST http://{idcrm}-crm-api.vionvi.com/contract

Параметры запроса

Параметр	Тип данных	Описание	Обязательно
contact_id	int	ID клиента	Да
org_id	int	ID организации	Нет
userIdOwner	int	ID ответственного	Нет
funnelStageId	int	ID этапа воронки	Да
locationCityId	int	ID города	Нет
locationUnitId	int	ID офиса	Нет

При выполнении запроса Access Token необходимо поместить в заголовки (ключ Authorization с указанием типа Bearer), а в теле запроса указать все необходимые параметры метода. При этом не забудьте, что сервер ожидает перечисление параметров в формате JSON, кодировке UTF-8

Пример запроса:
POST/contractHTTP/1.1
Authorization: Bearer ezI1NiJ9.eyJhdWQiOiIyIiwianRpIjoiNGNhMTgwMDczM2
Host: 1-crm-api.vionvi.com
Accept: application/json
Content-Type: application/json
Content-Length: 143

{
"contact_id": 1,
"org_id": 1,
"userIdOwner": 1,
"funnelStageId": 1,
"locationCityId": 1,
"locationUnitId": 1
}

Параметры ответа

Мы используем обычные коды ответов HTTP для обозначения результата выполнения запроса.
Ответ от сервера приходит в формате JSON и кодировке UTF-8.
При успешном ответе возвращаемый сервером результат будет представлен в теле ответа массивом data.
При ошибке выполнения запроса вы можете получить в теле ответа массив errors