Python SDK - An Overview

Python SDK - An Overview


Python SDK offers a way to create client python applications that can be integrated with Zoho CRM. This SDK makes the access and use of necessary CRM APIs with ease. In other words, it serves as a wrapper for the REST APIs, making it easier to use the services of Zoho CRM.

A point to note would be that the developer of the client application should create programming code elements along with configuration-related properties files, interface implementations, instances or objects. Authentication to access Zoho CRM APIs is through OAuth authentication mechanism. Invariably, HTTP requests and responses are taken care by SDK.

A sample of how an SDK acts a middle ware or interface between Zoho CRM and a client java application.



Python SDK allows you to:
  1. Exchange data between Zoho CRM and the client application where the CRM entities are modelled as classes. 
  2. CRM API equivalents are declared and defined as simple member methods in your python application. 
  3. Push data into Zoho CRM, by accessing appropriate APIs of the CRM Service. 
Environmental Setup

Python SDK is installable through "pip". Pip is a tool for dependency management in Python. The SDK requires the following from the client app:
  • Client app must have Python 2.7 and above. 
  • Client app must have python requests being installed 
  • Python SDK must be installed through pip. 
  • The method ZCRMRestClient.initialize() must be called on starting up of your application 
  • MySQL should run in the same machine serving at the default port 3306. 
    • The database name should be "zohooauth". 
    • There must be a table "oauthtokens" with the columns "user identifier"(varchar(100)), "accesstoken"(varchar(100)), "refreshtoken"(varchar(100)), "expirytime"(bigint).

SEE ALSO

Install the sdk
Register your application
Configuration
Initialization
Class Hierarchy
Responses & Exceptions
Errors & Solutions
Sample Codes
Release Notes

    • Related Articles

    • Installation - Python SDK

      The SDK can be installed for your client application through Pip. Pip is a tool for dependency management in Python. Installing Pip Please refer the document below to install pip https://pip.pypa.io/en/stable/installing/ Installing the SDK Run the ...

    • Responses & Exceptions - Python SDK

      APIResponse, BulkAPIResponse and FileAPIResponse are the wrapper objects for Zoho CRM APIs’ responses. All API calling methods would return one of these three objects. A method-seeking entity would return APIResponse object, whereas a method-seeking ...

    • Configuration - Python SDK

      Before you get started with creating your python application, you need to first authenticate the app with Zoho. And to do that there are some configuration procedures that need to be in place. There are two methods in which you can authenticate your ...

    • Release Notes - Python SDK

      ZCRMSDK -VERSION 1.0.8 Install command pip install zcrmsdk==1.0.8 Notes Enhancement: Duplicate check fields can be ignored if not necessary in upsert record method . ZCRMSDK -VERSION 1.0.7 Install command pip install zcrmsdk==1.0.7 Notes Enhancement: ...

    • Errors and Solutions - Python SDK

      In case you receive an error message when you access the Python SDK, use the links below to understand and figure out how to fix them. No OAuth and Configuration Properties Invalid Code KeyError: 'Email' Exception while fetching oauthtoken from DB ...