Is an asynchronous implementation for AlfaCRM API
Project description
AIOAlfacrm
aioalfacrm - is an asynchronous implementation for the AlfaCRM API
Package is in development
Installation using pip
$ pip install aioalfacrm
Example:
import asyncio
from aioalfacrm import AlfaClient
from aioalfacrm.models import Location
HOSTNAME = 'demo.s20.online'
EMAIL = 'api-email@email.example'
API_KEY = 'user-api-token'
BRANCH_ID = 1
async def main():
alfa_client = AlfaClient(
hostname=HOSTNAME,
email=EMAIL,
api_key=API_KEY,
branch_id=BRANCH_ID,
)
try:
# Check auth (Optionaly)
if not await alfa_client.check_auth():
print('Authentification error')
return
# Get branches
branches = await alfa_client.branch.list(page=0, count=20)
# Edit branch
for branch in branches:
branch.name = f'{branch.name} - Edited'
# Save branch
await alfa_client.branch.save(branch)
# Create location
location = Location(
branch_id=1,
is_active=True,
name='New location',
)
await alfa_client.location.save(location)
finally:
# Close session
await alfa_client.close()
asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy()) # For Windows
asyncio.run(main())
Available CRM objects
alfa_client.branch # Branch
alfa_client.customer # Customer
alfa_client.location # Location
alfa_client.study_status # StudyStatus
alfa_client.subject # Subject
alfa_client.lead_status # LeadStatus
alfa_client.lead_source # LeadSource
Available CRM methods
alfa_client. < object >.list(**filters) # Get objects list
alfa_client. < object >.get(id) # Get one object by id
alfa_client. < object >.save(model) # Create object
Paginator
# Get all objects
for page in alfa_client. < object >.get_paginator():
objects = page.items
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
aioalfacrm-0.1.1.tar.gz
(29.0 kB
view hashes)
Built Distribution
aioalfacrm-0.1.1-py3-none-any.whl
(20.9 kB
view hashes)
Close
Hashes for aioalfacrm-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 36825da12b360cd5374775f9586aa8b371fe55a28b8bad7a497e19fd95e39c26 |
|
MD5 | e6b9d69051df4cfd2330a8acd1b5fbad |
|
BLAKE2b-256 | 1a7d15d484983249f6226ed2da5437f27c73195507a0d75ea05defa63424dc49 |