Python API for Amocrm
Project description
Python AmoCRM API v2 (http://www.amocrm.ru/) (human interface for easy using)
Installation
pip install amocrm_api
Usage
Авторизация
Авторизация - с Июня 2020 amocrm форсировала смену авторизации с токена на Oauth Но Oauth без поддержки server to server взаимодействия, связи с чем текущая реализация содержит следующие ограничения 1. В личном кабинете необходимо создать интеграцию 2. Рефрешь токен однаразовый и обновляется при каждом получении аксесс токена 3. Токены нужно хранить, для этого есть api и существует 3 типа хранилиша (можно реализовать свой):
MemoryTokensStorage - хранит токены в памяти (если вы перезапускаете приложение то придется стнова создавать refresh_token)
FileStorage - сохраняет токены в файле
RedisTokensStorage - сохраняет токены в редисе (pip install redis) для new-age приложений каторые работают в нескольок инстансов
Example:
from amocrm.v2 import tokens tokens.default_token_manager( client_id="xxx-xxx-xxxx-xxxx-xxxxxxx", client_secret="xxxx", subdomain="subdomain", redirect_url="https://xxxx/xx", storage=tokens.FileTokensStorage(), # by default FileTokensStorage ) tokens.default_token_manager.init(code="..very long code...", skip_error=True)
Контакт - Contact
Компания - Company
Теги - Tags
Сделка - Lead
Задача - Task
Событие - Note
Работа с сушьностями
У каждой сущности есть менеджер (проперти objects), который имеет следующие методы
<Entity>.objects.get(object_id=1, query="test") # получение обьекта <Entity>.objects.all() # получение всех сущьностей <Entity>.objects.filter(**kwargs) # получение списка сущьностей с фильтром <Entity>.objects.create(**kwargs) # создание сущьности (нет явной сигнатуры поэтому лучше испольщовать метод create самой сушьности) <Entity>.objects.update(**kwargs) # обносление сущьности (нет явной сигнатуры поэтому лучше испольщовать метод update самой сушьности)
В свою очередь сама сушьность имеет несколько методов для более простого создания и обноления
<EntityInstance>.create() <EntityInstance>.update() <EntityInstance>.save() # создаст или обновит в зависимости от того как обьект был инициализирован
Рассмотрим полный флоу работы на примере контакта
from amocrm.v2 import Contact, Company contact = Contact.objects.get(query="Тест") print(contact.first_name) print(contact.company.name) print(contact.created_at) contact.last_name = "Новое" contact.tags.append("new") contact.save() contact.company = Company(name="Amocrm") # создаст и приленкует компанию сразу print(contact.company.id) len(list(contact.customers)) # lazy list contact.customers.append(Customer(name="Volta"))
Кастомные поля
Одна из удобных возможностей AmoCrm - кастомные поля
Example:
from amocrm.v2 import Lead as _Lead, custom_field class Lead(_Lead): utm = custom_field.UrlCustomField("UTM метка") delivery_type = custom_field.SelectCustomField("Способ доставки") address = custom_field.TextCustomField("Адрес")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for amocrm_api-2.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d908c60d26498e25436a28494eea0ba8d1076ddf93e85f78778010a8775ab763 |
|
MD5 | d56aa91a841f67f91662267529705a4b |
|
BLAKE2b-256 | 2afa11fbba70bc85e5de6fa7d625d3d7942a1843076487aaa6af7da4d9dba097 |