Документация API Цифровой платформы "Инвестиционные проекты"

Инвестиционные проекты и 1С:CRM. Интеграция

Мы предлагаем современное решение по интеграции Базы проектов и компаний в Вашу CRM систему. Данное решение позволит максимально быстро и упорядоченно пополнять вашу СRM новыми лидами из крупнейших инвестпроектов для дальнейшей работы с ними.

Смотреть описание CRM модуля

АРI (Application Programming Interface) — позволяет интегрировать данные Цифровой платформы "Инвестиционные проекты" с любой иной информационной системой или сервисом, который используется в Вашей организации. Это могут быть системы класса ERP или CRM, 1С, SAP, Oracle, бухгалтерские и банковские системы, корпоративные платформы и системы дистанционного банковского обслуживания и др.

Запросы формируются методом GET. Рекомендуемое ограничение для количества запросов в секунду: 5

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

Токен можно получить в личном кабинете, после регистрации на сайте https://investprojects.info

Документация для разработчика находится по адресу https://investprojects.info/api/v1_docs/main

При каждом запросе токен нужно передавать в header:

header('Authorization: Bearer YOUR_ACCESS_TOKEN');

Выбор формата ответа:

header('Accept:application/xml');

или

header('Accept:application/json');

2. Список поддерживаемых методов:

2.1) Метод получения списка проектов

Пример формирования запроса:

curl -i -H "Accept:application/xml" "https://investprojects.info/api/v1/project/list" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

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

Имя параметра	Тип данных	Описание
api_key	string	API ключ
page	integer	Номер страницы
pageSize	integer	Количество элементов на страницу (default: 20, max: 100)
fields	array	Необходимые поля массивом или строкой v.1: fields[0]=project_id&fields[1]=project_name&fields[2]=project_region_name&fields[3]=project_investments v.1_1: fields=project_id,project_name,project_region_name,project_investments
filter[regions_id][]	array	Фильтр по регионам (v.1) Пример: &filter[regions_id][]=3&filter[regions_id][]=4
regions	string	Фильтр по регионам (v.1_1) Пример: &regions=3,4,5,8
filter[own_id][]	array	Фильтр по виду собственности (v.1) Пример: &filter[own_id][]=1&filter[own_id][]=2
own	string	Фильтр по виду собственности (v.1_1) Пример: &own=1,2
filter[sectors_id][]	array	Фильтр по отраслям (v.1) Пример: &filter[sectors_id][]=34&filter[sectors_id][]=42
sectors	string	Фильтр по отраслям (v.1_1) Пример: &sectors=34,42
filter[stages_id][]	array	Фильтр по стадиям (v.1) Пример: &filter[stages_id][]=3&filter[stages_id][]=4
stages	string	Фильтр по стадиям (v.1_1) Пример: &stages=3,4
filter[new]	string	Фильтр по статусу проекта - 'Новый' (v.1) Пример: &filter[new]=1
new	string	Фильтр по статусу проекта - 'Новый' (v.1_1) Пример: &new=1
filter[updated]	string	Фильтр по статусу проекта - 'Обновлен' (v.1) Пример: &filter[updated]=1
updated	string	Фильтр по статусу проекта - 'Обновлен (v.1_1) Пример: &updated=1
filter[date_start]	string	Фильтр по дате создания проекта. В формате dd.mm.YYYY (v.1) Пример: &filter[date_start]=01.01.2022
filter[update_start]	string	Фильтр ОТ по дате обновления проекта. В формате dd.mm.YYYY (v.1) Пример: &filter[update_start]=01.02.2022
filter[update_end]	string	Фильтр ДО по дате обновления проекта. В формате dd.mm.YYYY (v.1) Пример: &filter[update_end]=01.08.2022
date_start	string	Фильтр по дате создания проекта. В формате dd.mm.YYYY (v.1_1) Пример: &date_start=01.01.2022
update_start	string	Фильтр ОТ по дате обновления проекта. В формате dd.mm.YYYY (v.1_1) Пример: &update_start=01.02.2022
update_end	string	Фильтр ДО по дате обновления проекта. В формате dd.mm.YYYY (v.1_1) Пример: &update_end=01.08.2022
filter[readGroup]	string	Фильтр 'Просмотренные общие' (v.1) Пример: &filter[readGroup]=1
readGroup	string	Фильтр 'Просмотренные общие' (v.1_1) Пример: &readGroup=1
filter[holding_id]	integer	Фильтр по холдингу (v.1) Пример: &filter[holding_id]=17
holding	integer	Фильтр по холдингу (v.1_1) Пример: &holding=17
filter[cost_from]	integer	Фильтр по размеру инвестиций в проект - 'от', млн руб. (v.1) Пример: &filter[cost_from]=100
cost_from	integer	Фильтр по размеру инвестиций в проект - 'от', млн руб. (v.1_1) Пример: &cost_from=100
filter[cost_to]	integer	Фильтр по размеру инвестиций в проект - 'до', млн руб. (v.1) Пример: &filter[cost_to]=500
cost_to	integer	Фильтр по размеру инвестиций в проект - 'до', млн руб. (v.1_1) Пример: &cost_to=500
filter[group_id][]	array	Фильтр по группам проектов (v.1) Пример: &filter[group_id][]=3&filter[group_id][]=4
groups	string	Фильтр по группам проектов (v.1_1) Пример: &groups=1,2,3,5
sort	string	Сортировка Например: По полю `name` по возрастанию: ?orderBy=name или ?orderBy=+name По полю `name` по убыванию: ?orderBy=-name Сортировка возможна по следующим полям: investments, id, name

Список возвращаемых параметров

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

Список отображаемых полей проекта
Response: 200

Имя параметра	Тип данных	Описание
projects	array
projects[project_id]	integer	ID проекта
projects[project_name]	string	Наименование проекта
projects[project_addtime]	integer	Дата добавления проекта
projects[project_last_update]	integer	Дата последнего обновления (актуализации) проекта
projects[project_next_update]	integer	Дата следующего обновления (актуализации) проекта
projects[project_begin]	integer	Дата начала проекта
projects[project_end]	integer	Дата завершения проекта
projects[project_stage_name]	string	Наименование стадии проекта
projects[project_stage_id]	integer	Идентификатор стадии проекта
projects[project_sector_name]	string	Наименование отрасли проекта
projects[project_region_name]	string	Наименование региона проекта
projects[project_type_own]	string	Наименование вида собственности проекта
projects[project_investments]	integer	Объем инвестиций
projects[project_short_description]	string	Краткое описание проекта
projects[project_has_contacts]	string
projects[project_groups]	integer[]	ID группы

2.2) Метод получения полной информации о проекте

Пример, формирования запроса:

curl -i -H "Accept:application/xml" "https://investprojects.info/api/v1/project/info" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Возвращаемые параметры:

Имя параметра	Тип данных	Описание
project_id	int64	Id проекта
project_name	string	Наименование проекта
project_addtime	timestamp	Дата добавления проекта
project_last_update	timestamp	Дата обновления проекта
project_next_update	timestamp	Дата следующего обновления проекта
project_begin	string	Дата начала проекта
project_end	string	Дата завершения проекта
project_stage_name	string	Наименование стадии проекта
project_stage_id	integer	Идентификатор стадии проекта
project_work_type	string	Наименование типа работ
project_sector_name	string	Наименование отрасли проекта
project_subsector_name	string	Наименование подотрасли проекта
project_type_own	string	Наименование типа собственности
project_investments	integer	Инвестиции (млн руб.)
project_factorypower	string	Производственная мощность проекта
project_products	array	Продукция проекта
project_products[okpd_code]	string	Код продукции по ОКПД
project_products[name]	string	Наименование продукции по ОКПД
project_short_description	string	Краткое описание проекта
project_description	string	Полное описание проекта
project_location		Местоположение проекта
project_square	string	Площадь проекта
project_area	string	Площадь участка
project_groups	integer[]	Id группы проектов
project_status	array	Статус проекта (см. Статус)
project_procurement_links	array	Ссылка на закупку
project_interview_results	array	Результаты интервью проекта
project_interview_results[date]	string	Дата интервью в формате ДД.ММ.ГГГГ
project_interview_results[source]	string	Компания, с которой проводилось интервью
project_interview_results[company_id]	integer	ID компании, с которой проводилось интервью
project_interview_results[company_inn]	integer	ИНН компании, с которой проводилось интервью (для иностранных компаний, при отсутствии инн, передается другой идентификатор - сайт или email или телефон)
project_interview_results[text]	string	Текст интервью
project_materials	array	Прогноз расхода материала (см. Материалы)
project_members	array	Участники проекта (см. Участники)

Материалы (project_materials)

Возвращаемые параметры:

Имя параметра	Тип данных	Описание
error	string	Ошибка
name	string	Наименование материала
material_id	integer	ID материала
amount	array	Количество
amount[value]	integer	Значение
amount[unit]	integer	Единицы измерения
cost	array	Стоимость
cost[value]	integer	Значение
cost[unit]	integer	Единицы

Участники (project_members)

Возвращаемые параметры:

Имя параметра	Тип данных	Описание
member_id	integer	ID участника
member_name	string	Тип участника
member_status	string	Статус участника проекта
member_company_name	string	Название компании
member_company_id	integer	Id компании
member_company_inn	string	ИНН компании (для иностранных компаний, при отсутствии инн, передается другой идентификатор - сайт или email или телефон)
member_company_kpp	string	КПП компании
member_company_okved_id	integer	ОКВЭД компании
member_company_okved_name	integer	Наименование основного вида деятельности компании
member_company_address		Юридический адрес компании
member_company_site	string	Сайт компании
member_company_phone	string	Телефон компании
member_company_email	string	Email компании
member_company_directors	array	Список лиц, имеющих право без доверенности действовать от имени юридического лица
member_company_directors[director_name]	string	ФИО
member_company_directors[director_position]	string	Должность
member_company_directors[director_innfl]	string	ИННФЛ
member_contacts	array	(см. Контакты участника)
holding	array	Холдинг
holding[id]	integer	Id холдинга
holding[slug]	string	Идентификатор холдинга
holding[name]	string	Название холдинга
holding[projects_count]	integer	Кол-во проектов активной стадии
holding[projects_investments]	integer	Инвестиции в проектах активной стадии, тыс руб.

Контакты участника (member_contacts)

Возвращаемые параметры:

Имя параметра	Тип данных	Описание
contact_id	integer	ID
contact_fio	string	ФИО
contact_position	string	Должность
contact_phone	string	Телефон
contact_email	string	Email
contact_company	array	Компания контакта
contact_company[id]	integer	id
contact_company[name]	string	Название
contact_company[inn]	string	ИНН (для иностранных компаний, при отсутствии инн, передается другой идентификатор - сайт или email или телефон)
contact_company[kpp]	string	КПП

2.3) Метод получения полной информации о компании

Пример, формирования запроса:

curl -i -H "Accept:application/xml" "https://investprojects.info/api/v1/company/info" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Возвращаемые параметры:

Имя параметра	Тип данных	Описание
id	string	ID компании
name	string	Наименование компании
inn	string	Инн компании (для иностранных компаний, при отсутствии инн, передается другой идентификатор - сайт или email или телефон)
phone	string	Телефон компании
email	string	E-mail компании
site	string	Сайт компании
location		Юридический адрес компании-участника проекта
company_projects	array	Проекты компании с участниками и их ролями. (см. Проекты компании)
communications	array	Связи компании (см. Связи компании)

Проекты компании (company_projects)

Возвращаемые параметры:

Имя параметра	Тип данных	Описание
id	integer	Id проекта
name	string	Наименование проекта
stage_id	integer	Идентификатор стадии проекта
stage_name	string	Наименование стадии проекта
role	string	Роль участника проекта
investments	string	Инвестиции (млн. руб.)
region_name	string	Местоположение проекта

Связи компании (communications)

Возвращаемые параметры:

Имя параметра	Тип данных	Описание
company_id	string	ID компании
company_name	string	Наименование компании
company_inn	string	Инн компании (для иностранных компаний, при отсутствии инн, передается другой идентификатор - сайт или email или телефон)
relation_text	string	Описание причины связи
sub_levels	array	Связанные компании (см. Связи компании)

2.4) Метод получения полной информации о холдинге

Пример, формирования запроса:

curl -i -H "Accept:application/xml" "https://investprojects.info/api/v1/holding/info" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Возвращаемые параметры:

Имя параметра	Тип данных	Описание
id	integer	Id холдинга
slug	string	Идентификатор холдинга
name	string	Название холдинга
investments	integer	Инвестиции
parents	array	Родительские холдинги
parents[id]	integer	Id холдинга
parents[slug]	string	Идентификатор холдинга
parents[name]	string	Название холдинга
child	array	Дочерние холдинги
child[id]	integer	Id холдинга
child[slug]	string	Идентификатор холдинга
child[name]	string	Название холдинга
companies_count	integer	Количество компаний холдинга
companiesData	array	Компании холдинга
companiesData[id]	integer	Id компании
companiesData[name]	string	Название компании
companiesData[inn]	string	ИНН компании (для иностранных компаний, при отсутствии инн, передается другой идентификатор - сайт или email или телефон)
companiesData[share]	string	Доля в компании
companiesData[receipts]	integer	Выручка компании, руб.
companiesData[netprofit]	integer	Чистая прибыль компании, руб.
companiesData[assets]	integer	Активы компании, руб.
companiesData[countProjects]	integer	Кол-во проектов компании
companiesData[status]	string	Статус юридического лица
news	array	Новости холдинга
news[date]	string	Дата, формат: д.м.г.
news[text]	string	Текст новости

2.5) Метод получения списка холдингов

Пример, формирования запроса:

curl -i -H "Accept:application/xml" "https://investprojects.info/api/v1/holding/list" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

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

Имя параметра	Тип данных	Описание
api_key	string	API ключ
page	integer	Номер страницы
pageSize	integer	Количество элементов на страницу (default: 20, max: 100)
fields	string	Необходимые поля массивом или строкой v.1: fields[0]=name&fields[1]=revenue&fields[2]=investments v.1_1: fields=name,revenue,investments
filter[regions][]	array	Фильтр по регионам (v.1) Пример: &filter[regions][]=1&filter[regions][]=2&filter[regions][]=3&filter[regions][]=5
regions	string	Фильтр по регионам (v.1_1) Пример: &regions=1,2,3,5
filter[sectors][]	array	Фильтр по отраслям (v.1) Пример: &filter[sectors][]=300&filter[sectors][]=330
sectors	string	Фильтр по отраслям (v.1_1) Пример: &sectors=300,330
filter[created_after_date]	string	Фильтр по дате создания (дней назад) (v.1) Пример: &filter[created_after_date]=14
created_after_date	string	Фильтр по дате создания (дней назад) (v.1_1) Пример: &created_after_date=14
filter[changed_after_date]	string	Фильтр по дате обновления (дней назад) (v.1) Пример: &filter[changed_after_date]=14 Следующие события позволяют считать информацию о холдинге обновлённой: - изменение объёма инвестиций проектов холдинга; - изменение состава компаний; - изменение состава дочерних холдингов.
changed_after_date	string	Фильтр по дате обновления (дней назад) (v.1_1) Пример: &changed_after_date=14 Следующие события позволяют считать информацию о холдинге обновлённой: - изменение объёма инвестиций проектов холдинга; - изменение состава компаний; - изменение состава дочерних холдингов.
filter[revenue_from]	integer	Фильтр по размеру выручки за прошлый год - 'от', тыс руб. (v.1) Пример: &filter[revenue_from]=10000
revenue_from	integer	Фильтр по размеру выручки за прошлый год - 'от', тыс руб. (v.1_1) Пример: &revenue_from=10000
filter[revenue_to]	integer	Фильтр по размеру выручки за прошлый год - 'до', тыс руб. (v.1) Пример: &fiter[revenue_to]=100000
revenue_to	integer	Фильтр по размеру выручки за прошлый год - 'до', тыс руб. (v.1_1) Пример: &revenue_to=100000
filter[investments_from]	integer	Фильтр по размеру инвестиций - 'от', млн руб. (v.1) Пример: &filter[investments_from]=10000
investments_from	integer	Фильтр по размеру инвестиций - 'от', млн руб. (v.1_1) Пример: &investments_from=10000
filter[investments_to]	integer	Фильтр по размеру инвестиций - 'до', млн руб. (v.1) Пример: &filter[investments_to]=100000
investments_to	integer	Фильтр по размеру инвестиций - 'до', млн руб. (v.1_1) Пример: &investments_to=100000
sort	string	Сортировка Например: По полю `name` по возрастанию: &sort=name или &sort=+name По полю `name` по убыванию: &sort=-name Сортировка возможна по следующим полям: id, name, addtime, last_update, investments, revenue, projects_cost. По умолчанию сортировка 'projects_cost DESC'

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

Список отображаемых полей холдинга
Response: 200

Имя параметра	Тип данных	Описание
holding	array
holding[id]	integer	ID холдинга
holding[name]	string	Наименование холдинга
holding[addtime]	integer	Дата добавления холдинга
holding[last_update]	integer	Дата последнего обновления холдинга
holding[projects_count]	integer	Количество проектов
holding[investments]	integer	Инвестиции, млн руб.
holding[revenue]	integer	Выручка за прошлый год, млн руб.
holding[companies_count]	integer	Количество компаний холдинга
holding[main_company_inn]	integer	ИНН головной компании (для иностранных компаний, при отсутствии инн, передается другой идентификатор - сайт или email или телефон)
holding[new]	integer	Добавлен менее 30 дней назад
holding[changed]	integer	Изменен менее 30 дней назад
holding[projects_cost]	integer	Сумма инвестиций проектов по фильтру

2.6) Метод получения списка Групп проектов

Пример, формирования запроса:

curl -i -H "Accept:application/xml" "https://investprojects.info/api/v1/projectsGroups/list" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

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

Имя параметра	Тип данных	Описание
api_key	string	API ключ
page	integer	Номер страницы
pageSize	integer	Количество элементов на страницу (default: 20, max: 100)
fields	array	Необходимые поля массивом или строкой v.1: fields[0]=name&fields[1]=sector_id&fields[2]=investments v.1_1: fields=name,sector_id,investments
filter[sectors][]	array	Фильтр по отраслям (v.1) Пример: &filter[sectors][]=34&filter[sectors][]=42
sectors	string	Фильтр по отраслям (v.1_1) Пример: &sectors=1,2,3,5
sort	string	Сортировка Например: По полю `name` по возрастанию: &sort=name или &sort=+name По полю `name` по убыванию: &sort=-name Сортировка возможна по следующим полям: id, name, sector_id, projects_count, investments По умолчанию сортировка 'name ASC'

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

Список отображаемых полей списка Групп проектов
Response: 200

Имя параметра	Тип данных	Описание
projectsGroup	array
projectsGroup[id]	integer	ID группы проектов
projectsGroup[name]	string	Наименование группы проектов
projectsGroup[projects_count]	integer	Количество проектов
projectsGroup[investments]	integer	Инвестиции, млн руб.
projectsGroup[sector_id]	integer	ID отрасли

2.7) Метод получения информации о Группе проектов

Пример, формирования запроса:

curl -i -H "Accept:application/xml" "https://investprojects.info/api/v1/projectsGroups/info" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Возвращаемые параметры:

Имя параметра	Тип данных	Описание
id	integer	ID группы проектов
name	string	Название группы проектов
description	string	Описание группы проектов
place	string	Местоположение группы проектов

2.8) Метод получения информации о лимитах

Пример, формирования запроса:

curl -i -H "Accept:application/xml" "https://investprojects.info/api/v1/account/info?limit=project" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Возвращаемые параметры:

Имя параметра	Тип данных	Описание
limit	string	Название лимита (возможные значения: project, project-re, project-list, company, holding, project-groups )
used	int	Использовано
total	int	Лимит

Механика списания лимитов:

Лимиты project (2.2 Метод получения полной информации о проекте)
- Происходит списание 1 лимита за 1 проект.
- Повторное получение информации об одном и том же проекте в рамках установленного периода не тратит лимит.
Лимиты project-re (2.2 Метод получения полной информации о проекте)
- Происходит списание 1 лимита за просмотр 1 проекта, просмотренного по истечению действия периода лимита (1).
- Повторное получение информации об одном и том же проекте тратит лимит.
Лимиты project-list (2.1 Метод получения списка проектов)
- Происходит списание 1 лимита за каждый проект в полученном списке.
- Повторное получение одного и того же проекта в одном и том же списке или разных списках проектов в рамках установленного периода не тратит лимит.
Лимиты company (2.3 Метод получения полной информации о компании)
- Происходит списание 1 лимита за карточку 1 компании.
- Повторное получение информации об одной и той же компании в рамках установленного периода не тратит лимит.
Лимиты holding (2.4 Метод получения полной информации о холдинге)
- Происходит списание 1 лимита за карточку 1 холдинга.
- Повторное получение информации об одном и том же холдинге в рамках установленного периода не тратит лимит.
Лимиты project-groups (2.7 Метод получения полной информации о группе проектов)
- Происходит списание 1 лимита за карточку 1 группы проектов.
- Повторное получение информации об одной и той же группе проектов в рамках установленного периода не тратит лимит.