C# SDK - Overview
C# SDK offers a way to create client C# 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 C# application.
C# SDK allows you to:
- Exchange data between Zoho CRM and the client application where the CRM entities are modelled as classes.
- CRM API equivalents are declared and defined as simple functions in your C# application.
- Push data into Zoho CRM, by accessing appropriate APIs of the CRM Service.
- You must have .net framework 4.6.1 or above for the SDK to work.
C# SDK is available as a Nuget package. The SDK requires the following from the client app:
The ZCRMSDK assembly can be installed through the Nuget Package Manager and through the following options:
- Packet Manager
Install-Package System.IO.Compression.ZipFile -Version 4.3.0
Install-Package System.IO.Compression -Version 4.3.0
- .NET CLI
dotnet add package ZCRMSDK
dotnet add package Newtonsoft.Json
dotnet add package MySql.Data [Only if DB persistence is used]
dotnet add package System.IO.Compression.ZipFile --version 4.3.0
dotnet add package System.IO.Compression --version 4.3.0
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.