talkzoho 3.0.0

Asynchronous wrapper for Zoho's numerous APIs

A python wrapper library for Zoho API calls which aims to unify the API for the different Zoho Products (CRM, Support, Projects etc).

NOTE: Only the crm client is in a production ready state.

The library has asynchronous interface i.e.

from talkzoho import CRMClient


async def main():
    crm     = CRMClient(auth_token='xxx')
    account = await crm.accounts.get('7030050000019540342')

However, Talk Zoho also provides the helper function talkzoho.utils.wait for usage in synchronous code.

from talkzoho import CRMClient
from talkzoho.utils import wait


account = wait(crm.accounts.get, '7030050000019540342')

Installation

pip install talkzoho

Example Usage

from talkzoho import CRMClient


async def main():
    crm = CRMClient(auth_token='xxx')

    # Get Account
    account = await crm.accounts.get('7030050000019540342')

    # Insert Lead
    lead_id = await crm.leads.insert({
        'First Name': 'Bill',
        'Last Name': 'Billson'})

    # Filter Leads
    bills = await crm.leads.filter(term='Bill', limit=1)

    # Update Contact
    contact_id = await crm.contacts.update({
        'CONTACTID': '7030050000019540536',
        'First Name': 'Jill',
        'Last Name': 'Jillson'})

    # Delete Contact
    success = await crm.contacts.delete('7030050000019540536')

Renamed and Custom Modules

Talk Zoho supports renamed standard modules; when initialising the CRMClient pass the flag to indicate if you want to use Zoho’s canonical names or the user’s aliases. The flag (use_module_aliases) defaults to False.

async def main():
    crm = CRMClient(auth_token='xxx', use_module_aliases=False)
    potential = await crm.potentials.get('7030050000019540360')

    crm = CRMClient(auth_token='xxx', use_module_aliases=True)
    opportunity = await crm.opportunities.get('7030050000019540360')
    # potential == opportunity

This works the same for custom modules:

async def main():
    crm = CRMClient(auth_token='xxx', use_module_aliases=False)
    custom_record = await crm.custom_module_8.get('9130050000019540360')

    crm = CRMClient(auth_token='xxx', use_module_aliases=True)
    partner = await crm.partners.get('9130050000019540360')
    # custom_record == partner

Error Handling

Zoho use a number of ways to inform the client of errors. For example, CRM always returns a 200 status code with a error message and code in the body, where as books will return more standard looking HTTP errors. Talk Zoho tries to unify these and raises a `tornado.web.HTTPError <http://www.tornadoweb.org/en/stable/web.html#tornado.web.HTTPError>`__. Talk Zoho will also map the Zoho specific codes to their HTTP status code equivalent.

NOTE: Deleting a CRM record (with a correct-looking id) will never return an error.This is the behavior of Zoho’s CRM API.

from talkzoho import CRMClient
from tornado.web import HTTPError


async def main():
    crm = CRMClient(auth_token='xxx')

    try:
        account = await crm.accounts.get('1234')
    except HTTPError as http_error:
        # HTTPError(404, reason='No record available with the specified record ID.')
        print(http_error)