Getting Started with the Zuora API

Overview

The Z-Commerce API is designed for any developer working on a subscription service who needs:

• A means to sell, monetitze, and manage subscription services.
• The flexibility to easily change pricing, packaging, billing, and payment options with minimal IT intervention.

This topic describes the steps required to begin working with the Zuora API.

Getting Started

To get started using Zuora:

• Sign up for an account with Zuora.
• Set up your development environment to use the Zuora Z-Commerce API. See "Initial Tasks" for more information.
• Read this API documentation, see the latest features, view our sample code, and start coding!
• If you have further questions, use our Support forums. Our forums are a great resource to seek help from Zuora and your fellow Z-Commerce API developers.

Initial Tasks

Here are the first things to do to start creating your client application.

1. Have a SOAP development environment (one that consumes a WSDL) installed and ready to use.
2. Contact your Zuora representative to obtain information on accessing the Zuora server, and to obtain access credentials (a login name and password). The Zuora server provides an administrative application that you can use to set certain global properties and to manually perform all the actions that you can perform using the API. When a field in this documentation is said to have its values set in the administrative (Admin) application, this is the application that is meant.
3. For coding purposes, you will need Zuora's Web Services Description Language (WSDL) file. The WSDL is essential to using the API; it defines the interface to Zuora's Web services. Obtain the WSDL file from within the Zuora UI: Z-Billing > Admin > Download the Zuora WSDL. This will ensure you have the latest WSDL file.
4. Import the WSDL file into your development environment. Using the WSDL, your development environment can generate an API to access the Zuora Web services. Your development environment may have a wizard for importing WSDLs.

Using Zuora with Your Website

The Z-Commerce API allows you to plug billing, payment, and subscription management services into your website directly. The Z-Commerce Platform gives you access to Z-Billing, Z-Payments, and Z-Force applications via an open API.

Related