PythonSDK
         
         
         
         
                       Version 3
         
         
         
         
         
         
         
         
         
         
         
         
         
         
         
         
         
                                      Zoho CRM 
                                        -zoho.com/crm- 
           
          Table of Contents 
             1. Overview......................................................................................................................3 
                  a. Environmental Setup 
             2. Installation of SDK......................................................................................................4 
             3. Register your application...........................................................................................5 
             4. Configuration...............................................................................................................6 
             5. Initialization...............................................................................................................11 
                  a. Generating the grant token 
             6. Class Hierarchy.........................................................................................................16 
             7. Token Persistence.....................................................................................................18 
                  a. Database Persistence 
                  b. File Persistence 
                  c. Custom Persistence 
             8. Responses and Exceptions......................................................................................22 
                  a. For GET Requests 
                  b. For POST, PUT, DELETE Requests 
             9. Threading and Multi-user Support..........................................................................24 
             10.Sample Codes...........................................................................................................39 
             11. Release Notes..........................................................................................................56 
           
           
           
           
           
           
           
           
           
           
           
           
           
           
           
           
                                             Zoho CRM 
                                               -zoho.com/crm- 
           
          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 interface implementations, instances or 
          objects. Authentication to access Zoho CRM APIs is through OAuth2.0 authentication 
          mechanism. Invariably, HTTP requests and responses are taken care of by the SDK. 
           
          A sample of how an SDK acts a middle ware or interface between Zoho CRM and a 
          client Python 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. Declare and define CRM API equivalents as simple member and 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 (version 3 and above) 
                 ■ https://www.python.org/downloads/ 
            ● Python SDK must be installed through pip. 
                                           Zoho CRM 
                                             -zoho.com/crm- 
            
            Note: 
            
               ● It is mandatory for the client to have ZohoCRM.settings.fields.ALL to access all 
            
                 the record operations API. Otherwise, the system returns the 
            
                 OAUTH-SCOPE-MISMATCH error 
            
               ● The access and refresh tokens are environment-specific and domain-specific. 
            
                 When you handle various environments and domains such as Production, 
            
                 Sandbox, or Developer and IN, CN, US, EU, or AU, respectively, you must use the 
            
                 access token and refresh token generated only in those respective environments 
            
                 and domains. The SDK throws an error, otherwise. 
            
               ● For example, if you generate the tokens for your Sandbox environment in the CN 
            
                 domain, you must use only those tokens for that domain and environment. You 
            
                 cannot use the tokens generated for a different environment or a domain. 
            
            
            
                         
           Installation of 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/ 
            
           Including the SDK in your project 
           You can include the SDK in your project using: 
             ● Install Python from python.org (if not installed). 
             ● Install Python SDK. Here's how you install the Python SDK 
                  ■ Navigate to the workspace of your client app. 
                  ■ Run the command below: 
         1 pip install zcrmsdk==3.x.x 
            
            
            
            
                                              Zoho CRM 
                                                -zoho.com/crm-