Zuora client libraries
Zuora client libraries (also known as SDKs) make it easy for developers to start using and integrating with the Zuora REST APIs.
This section contains the installation instructions to access these libraries in several popular server-side programming languages.
For the sample codes in different use cases, see Tutorials.
Access Zuora client libraries
Java library
Maven
We provide a Java library, which you can use by adding the following dependency to thepom.xml
file of your project:<dependency>
<groupId>com.zuora.sdk</groupId>
<artifactId>zuora-sdk-java</artifactId>
<version>$version</version>
</dependency>
$version
with 3.3.0
or a later Zuora Java library version.See Java library reference documentation for detailed classes and methods in Java client library.
Gradle
Addzuora-sdk-java
to the dependencies block of your build.gradle
file:dependencies {
implementation("com.zuora.sdk:zuora-sdk-java:$version")
// ...
}
$version
with 3.3.0
or a later Zuora Java library version.See Java library reference documentation for detailed classes and methods in Java client library.
Node.js library
Install the Zuora Node.js library by running the following command:
npm i zuora-sdk-js
See Node.js library reference documentation for detailed classes and methods in Node.js client library.
Python library
Install the Zuora Python library by running the following command:
pip install zuora-sdk
See Python library reference documentation for detailed classes and methods in Python client library.
C# library
Zuora C# client library is a beta version product. We recommend that you try it to start testing or integrating with Zuora.
Using .NET Core CLI
Install the Zuora C# library by running the following .NET Core CLI command:
dotnet add package ZuoraSDK
Using NuGet CLI
Install the Zuora C# library by running the following NuGet CLI command:
nuget install ZuoraSDK
Using the Package Manager Console
Install the Zuora C# library by using the Visual Studio NuGet Package Manager Console:Install-Package ZuoraSDK
Install within the Visual Studio
You can choose to install Zuora C# client library within Visual Studio by following the steps below. For more information about installing a package within Visual Studio, see Install and manage packages in Visual Studio.- Open the Solution Explorer in Visual Studio.
- Right-click on a project within your solution.
- Click Manage NuGet Packages.
- Click the Browse tab and search for
ZuoraSDK
. - Select the ZuoraSDK package, then select the appropriate version in the right-tab and click Install.
See C# library reference documentation for detailed classes and methods in the C# client library.
Limitations
- The Zuora client libraries do not provide support for Zephr and Togai.
- The Zuora client libraries do not support the following API operations: