apiAmoCRM 0.2.0

Api for amoCRM

Документация по библиотеке amoAPI

Библиотека amoAPI предоставляет удобный интерфейс для взаимодействия с API amoCRM. В данной документации описаны основные методы для работы с сущностями amoCRM.

Содержание

1. Инициализация
2. Методы для получения сущностей
   • Сделки
   • Контакты
   • Компании
   • Пользователи
3. Методы для создания сущностей
4. Методы для обновления сущностей
5. Дополнительные методы

Инициализация

Перед началом работы необходимо инициализировать API, передав в конструктор токен и URL вашего amoCRM аккаунта.

from amoAPI import API

api = API(token="ваш_токен", url="ваш_url")

Методы для получения сущностей

Сделки

Получение всех сделок

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

deals = api.get_leads(params={})

Получение сделки по ID

Метод для получения конкретной сделки по её ID:

deal = api.get_lead(id=123)

Контакты

Получение всех контактов

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

contacts = api.get_contacts(params={})

Получение контакта по ID

Метод для получения конкретного контакта по его ID:

contact = api.get_contact(id=123)

Компании

Получение всех компаний

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

companies = api.get_companies(params={})

Получение компании по ID

Метод для получения конкретной компании по её ID:

company = api.get_company(id=123)

Пользователи

Получение всех пользователей

Метод для получения списка всех пользователей:

users = api.get_users()

Методы для создания сущностей

Создание сделки

Метод для создания новой сделки:

new_deal = api.create_lead()

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

Метод для создания нового контакта:

new_contact = api.create_contact()

Создание компании

Метод для создания новой компании:

new_company = api.create_company()

Методы для обновления сущностей

Обновление сделки

Метод для обновления существующей сделки:

updated_deal = api.patch_lead(lead=deal)

Обновление контакта

Метод для обновления существующего контакта:

updated_contact = api.patch_contact(contact=contact)

Обновление компании

Метод для обновления существующей компании:

updated_company = api.patch_company(company=company)

Дополнительные методы

Создание сложной сделки

Метод для создания сложной сделки с контактами и пользовательскими полями:

complex_deal = api.complex_create_lead(body=[{"name": "Сложная сделка"}], contacts=[{"id": 123}], fields=[{"field_id": 456, "values": [{"value": "значение"}]}])

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

Метод для добавления текстовой заметки к сделке:

api.add_lead_text_note(lead=deal, text="Текст заметки")

Создание источника

Метод для создания нового источника:

new_source = api.create_source(name="Источник", id="external_id")

Удаление источника

Метод для удаления источника:

deleted_source = api.delete_source(id=123)

Получение всех источников

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

sources = api.get_sources()

Получение ссылок контакта

Метод для получения связей контактов:

contact_links = api.get_contact_links(contacts_id=[1, 2, 3], chats_id=["chat1", "chat2"])

Получение ссылок сделки

Метод для получения связей сделки:

lead_links = api.get_lead_links(lead_id=123)

Получение пользовательских полей

Метод для получения пользовательских полей для сущности:

custom_fields = api.get_cfs(entity_type="leads")

Создание пользовательского поля

Метод для создания нового пользовательского поля:

new_cf = api.create_cf(cf=custom_field, entity_type="leads")

Эта документация описывает основные методы для работы с API amoCRM, предоставляемые библиотекой amoAPI. Используйте эти методы для взаимодействия с сущностями amoCRM: сделками, контактами, компаниями и пользователями.