Knowledge Center

Knowledge Center > API > REST API > REST API Introduction

REST API Introduction

This article introduces you to Zuora REST API – a set of use case-oriented calls designed for webstore front integrations and revenue recognition.

REST API at Zuora

REST is a newer web-service protocol that lends itself to rapid development by using everyday HTTP and JSON technology. REST offers the following:

  • Easy to use and learn for developers
  • Works with virtually any language and platform
  • Use case-oriented calls
  • Well-suited for solutions that fall outside the traditional desktop application model

The Zuora REST APIs provide a set of use case-oriented calls:

  • Enable Web Storefront integration between your websites.
  • Support self-service subscriber sign-ups and account management.
  • Process  revenue schedules through custom revenue rule models. 

Our REST API documentation is organized by:

  • REST API basics: General topics like the base URL, authentication, error handling, and response pagination
  • REST API reference: Details for each of the API calls
  • REST Sample Code Libraries: Download links and brief documentation for our sample code libraries, which encapsulate the REST API functionality in Java and Ruby libraries

Which Protocol Should I Use – SOAP or REST?

To complement our extensive web-based user interface, Zuora provides a comprehensive set of APIs, along with code samples libraries, that allow you to create custom applications to integrate with the Zuora platform.  Our APIs are most commonly used to enable subscribers to sign up and manage their accounts on our merchants' websites in a self-service manner, but they can also be used to integrate with front- and back-office systems.

For flexibility and convenience, Zuora provides both a SOAP API and a REST API.  Before getting started with our APIs, you should review the differences between our SOAP and REST APIs and select the option that will work best for your business.

If desired, you can use both our SOAP and REST APIs for your business

Web Storefront Integration

Use REST API to enable a Web Storefront integration between your websites and Zuora to support self-service subscriber sign-ups and account management.

Compared to the SOAP API, the Zuora REST API is distinctive in two primary ways:

  1. Designed for web storefront integration: Introduced more recently, the REST API focuses on allowing merchants to integrate Zuora with their websites for self-service subscriber sign-ups and account management.  For merchants with this specific set of use cases, the REST API will get you up and running quickly and fulfill your application development requirements.
  2. Calls based on use cases: Our REST API is designed to match real-world commerce use cases, requiring relatively little knowledge of the underlying Zuora object model. Operations that require multiple calls in the SOAP API are combined into one call in REST.  For instance, with a single REST call you can:
  • Retrieve your entire Zuora product catalog, including products, rate plans and charges
  • Get detailed information for a customer account, including the customer's subscriptions, invoices, payments, and usage data
  • Create a new customer account with subscription and payment method details, as well as invoicing and collecting payment for the subscription.

REST API does not currently provide integration with the full range of Zuora functionality.  For example, the REST API does not let you edit your product catalog, create invoice item adjustments, or issue refunds.  If your integration use cases extend beyond a web self-service storefront integration, consider SOAP API or the Zuora UI.

Last modified
21:50, 5 May 2016

Tags

This page has no custom tags.

Classifications

(not set)