API_v1¶

Рекомендуется использовать APIv3.

Для PHP доступна библиотека для работы с запросами APIv1.

Общие правила
- Формат запроса
- Ограничения API
Работа со списками
- Список системных и пользовательских фильтров для задач проектов, контактов и сделок
Загрузка файлов
- Входные параметры
- Примеры загрузки файлов
- Фильтрация
- Пейджинация
Инструменты
Аутентификация и авторизация
- Запрос на получение параметров доступа
- Параметры доступа для приложений
- Алгоритм формирования сигнатуры
- Пример сформированных сигнатур и запросов
- Генерация одноразового ключа для авторизации
- Идентификационная информация
Сотрудники
- Карточка сотрудника
- Создание сотрудника
- Редактирование сотрудника
- Список сотрудников
- Допустимые действия над сотрудником
- Проверка прав на создание нового сотрудика для текущего пользователя
- Идентификаторы сотрудников работающих в Мегаплане
- Список отделов
- Блокировка
- Разблокировка
- Увольнение
Задачи
- CRUD-операции
- Другие действия
- Метаинформация
Проекты
- Допустимые действия над проектом
- Действие над проектом
- Допустимые действия над списком проектов
- Проверка прав на создание нового проекта для текущего пользователя
- Карточка проекта
- Список полей проекта
- Конвертировать проект в задачу
- Создание проекта
- Редактирование проекта
- Список проектов
- Добавить проект в избранное
- Редактирование Аудиторов
- Редактирование Соисполнителей
Списки дел
- Список списков дел
- Создание списка дел
- Редактирование списка дел
- Удаление списка дел
Чек-листы
- Список чек-листов по задачам, проектам или сделкам
- Чек-лист задачи, проекта или сделки
- Создание нового пункта чек-листа
- Обновление пункта чек-листа
- Переключение пункта чек-листа
- Удаление пункта чек-листа
События
- Карточка события
- Список категорий события
- Создание события
- Удаление события
- Завершение/возобновление события
- Список событий
- Список мест для проведения коммуникации
- Обновление события
Контакты
- Карточка контакта
- Редактирование/Создание контакта
- Удаление контакта
- Список полей контакта
- Список контактов
- Блокировка
- Разблокировка
Каналы привлечения контактов
- Список каналов привлечения
- Редактирование/Создание канала привлечения
- Карточка канала привлечения
- Удаление канала привлечения
Статусы контактов
- Список статусов
- Редактирование/Создание статуса
- Карточка статуса
- Удаление статуса
Типы контактов
- Список типов
- Редактирование/Создание типа
- Карточка типа
- Удаление типа
Сделки
- Получение списка доступных полей сделки
- Карточка сделки
- Список сделок
- Список схем сделок
- Редактирование/Создание сделки
- Интеграция с интернет-магазинами
- Привязка процесса или задачи к процессу
- Отвязка сделки или задачи от сделки
- Запуск сценария
Счета и товары
- Счета
- Товары
Финансы
- Список счетов
- Список типов операций
- Список операций
- Карточка операции
- Создание/редактирование операции
- Удаление операции
Комментарии
- Список всех комментариев по актуальным задачам и проектам
- Загрузка одного комментария по идентификатору
- Создание комментария
- Список комментариев по задаче/проекту/контакту/процессу/делу/переписке
- Список комментариев по нескольким объектам
- Отметить комментарий как прочитанный
Обсуждения
- Карточка обсуждения
- Создание обсуждения
- Удаление обсуждения
- Редактирование обсуждения
- Список обсуждений
- Список разделов обсуждений
- Открыть/Закрыть обсуждение
Сообщения
- Карточка сообщения
- Создать сообщение
- Удалить сообщение
- Список сообщений
Плательщики
- Карточка плательщика
- Изменение контрагента плательщика
- Список полей плательщика
- Список плательщиков
- Редактирование/Создание плательщика
Глобальный поиск
- Входные параметры
- Выходные данные
Система
- Серверное время
- Обратная связь
Метки
- Назначение меток
- Создание новой метки
- Удалить метки
- Список меток
- Список меток
- Обновление существующей метки
История изменений
- История изменений
- Пример ответа в JSON-формате
- Пример ответа в XML-формате
- История изменений по всем актуальным задачам и проектам
- История изменений отдельного объекта
Избранное
- Добавить в избранное
- Список избранного
- Удалить из избранного
Уведомления
- Уведомления
- Предупреждения
Справочники
- Список валют
- Список возможных типов телефонных номеров
- Список налогов
- Список единиц измерения товаров