https://github.com/zoho/zohocrm-python-sdk-6.0

https://github.com/zoho/zohocrm-python-sdk-6.0

Last synced: 7 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/zoho/zohocrm-python-sdk-6.0
• Owner: zoho
• License: apache-2.0
• Created: 2023-12-14T13:28:18.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-03-14T12:28:49.000Z (about 2 years ago)
• Last Synced: 2024-03-15T12:35:56.772Z (about 2 years ago)
• Language: Python
• Size: 578 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ZOHO CRM PYTHON SDK 6.0 for API version 6

The Python SDK for Zoho CRM allows developers to easily create Python applications that can be integrated with Zoho CRM. This SDK serves as a wrapper for the REST APIs, making it easier to access and utilize the services of Zoho CRM. 

Authentication to access the CRM APIs is done through OAuth2.0, and the authentication process is streamlined through the use of the Python SDK. The grant and access/refresh tokens are generated and managed within the SDK code, eliminating the need for manual handling during data synchronization between Zoho CRM and the client application.

This repository includes the Python SDK for API v6 of Zoho CRM. Check [Versions](https://github.com/zoho/zohocrm-python-sdk-6.0/releases) for more details on the versions of SDK released for this API version.

License

=======

    Copyright (c) 2021, ZOHO CORPORATION PRIVATE LIMITED 

    All rights reserved. 

    Licensed under the Apache License, Version 2.0 (the "License"); 

    you may not use this file except in compliance with the License. 

    You may obtain a copy of the License at 

    

        http://www.apache.org/licenses/LICENSE-2.0 

    

    Unless required by applicable law or agreed to in writing, software 

    distributed under the License is distributed on an "AS IS" BASIS, 

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 

    See the License for the specific language governing permissions and 

    limitations under the License.

## Latest Version

- [8.0.0](/versions/8.0.0/README.md)

  - Supported multiple field update operations in FieldsOperations class.

  - Updated Fields meta error handling in Utility class.

- [7.0.1](/versions/7.0.1/README.md)

  - Handled Record `rollup_summary` datatype.

- [6.0.1](/versions/6.0.1/README.md)

  - FileStore issue fixed.

- [6.0.0](/versions/6.0.0/README.md)

  - Blueprint Transition percent_partial_save field datatype changed(int to float).

  - Blueprint Field convert_mapping field datatype changed(ConvertMapping to dict).

  - Handled Record Field API Name and datatype.

  - Record FileDetails id field datatype changed(int to str).

  - Added new fields (created_time__s, modified_time__s, created_by__s, owner__s, and modified_by__s) in Record FileDetails class.

  - Record ImageUpload id field datatype changed(int to str).

  - Record multi_user_lookup type fields datatype changed([MinifiedUser] to [Record]).

  - Added new type and owner_id param in EmailRelatedRecordsOperations class constructor.

  - Added new id and name param in GetDownloadAttachmentsDetailsParam class.

  - Added new ids param in GetAppointmentsRescheduledHistoryParam class.

- [5.0.0](/versions/5.0.0/README.md)

  - Email Drafts ScheduleDetails timezone field datatype changed (TimeZone to str).

  - ShiftHours timezone field datatype changed (TimeZone to str).

  - Users time_zone field datatype changed(TimeZone to str).

- [4.0.0](/versions/4.0.0/README.md)

    - Users phone and mobile field datatype changed(int to str).

    - Support move_attachments_to field in the LeadConverter class.

- [2.0.0](/versions/2.0.0/README.md)

    - Changed favorite field datatype in CustomViews.

    - Changed tabTraversal field datatype in Layouts Sections.

    - Support for the following new APIs.

        - CustomViews

            - [Change Sort Order of Custom Views](https://www.zoho.com/crm/developer/docs/api/v6/sort-order-cv.html)

        - Users

            - [Users Count](https://www.zoho.com/crm/developer/docs/api/v6/users-count.html)

        - Features

            - [User Licences Count](https://www.zoho.com/crm/developer/docs/api/v6/get-user-licences.html)

- [1.0.0](/versions/1.0.0/README.md)

    - Python SDK upgraded to support v6 APIs.

    - Python SDK improved to support the following new APIs

      - [Unsubscribe Links](https://www.zoho.com/crm/developer/docs/api/v6/get-unsubscribe-links.html)

      - [Find and Merge API](https://www.zoho.com/crm/developer/docs/api/v6/merge-records.html)

      - [Get Related Records of Deleted Record API](https://www.zoho.com/crm/developer/docs/api/v6/get-related-records-of-deleted-record.html)

      - [Features API](https://www.zoho.com/crm/developer/docs/api/v6/get-features.html)

      - [Global Picklist API](https://www.zoho.com/crm/developer/docs/api/v6/get-global-picklist.html)

      - [Unblock Email API](https://www.zoho.com/crm/developer/docs/api/v6/unblock-emails.html)

For older versions, please [refer](https://github.com/zoho/zohocrm-python-sdk-6.0/releases).

## Including the SDK in your project

You can include the SDK to your project using:

- For including the latest [version](https://github.com/zoho/zohocrm-python-sdk-6.0/releases/tag/8.0.0)

    - Install **Python** from [python.org](https://www.python.org/downloads/) (if not installed).

    - Install **Python SDK**

        - Navigate to the workspace of your client app.

        - Run the command below:

        ```sh

        pip install zohocrmsdk6_0

        ```

    - The Python SDK will be installed in your client application.

**NOTE** 

> - 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**, **JP**, 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.

> - For **Deal Contact Roles API and Records API**, you will need to provide the **ZohoCRM.settings.fields.ALL** scope along with the **ZohoCRM.modules.ALL** scope while generating the OAuthtoken. Otherwise, the system returns the **OAUTH-SCOPE-MISMATCH** error.

> - For **Related Records API**, the scopes required for generating OAuthtoken are **ZohoCRM.modules.ALL**, **ZohoCRM.settings.fields.ALL** and **ZohoCRM.settings.related_lists.ALL**. Otherwise, the system returns the **OAUTH-SCOPE-MISMATCH** error.

> - For **Mass Convert API**, you will need to provide the **ZohoCRM.settings.fields.ALL** scope along with the **ZohoCRM.mass_convert.leads.CREATE** and **ZohoCRM.mass_convert.leads.READ** scope while generating the OAuthtoken. Otherwise, the system returns the **OAUTH-SCOPE-MISMATCH** error.

---

For more details, kindly refer [here](/versions/8.0.0/README.md).