Overview

Zephyr provides direct access to a variety of analytics and return data used to power Zephyr OnDEMAND. The REST API can be accessed using standard HTTP requests, either from your web browser, custom application, or a command-line tool such as curl.

Authentication

Authentication occurs in one of two ways: ASP.net sessions or Basic Authentication. When using Zephyr OnDEMAND through a browser based application, an ASP.net session can be established by going through the Zephyr OnDEMAND login page at zephyrondemand.com or the site-specific URL provided by your account manager.

We also offer Basic Authentication so that our web services can be used outside of a browser. For example, if your ZoD username is john.smith@bigcorp.com, and your ZoD password is letMeIn, you can access our Monte-Carlo service with curl via

curl https://john.smith%40bigcorp.com:letMeIn@zephyrondemand.com/api/mc/2?numperiods=5

The response will be a bit of trivial JSON (you can find more information about our Monte-Carlo service in the Detailed API listings below):

{"reportedPeriods":[1,2,3,4,5]}

Note that for most clients that can parse basic authorization credentials encoded in the URL (e.g. curl, wget, most browsers), the @ in john.smith@bigcorp.com needs to be URL encoded as %40. Also note that your username and password are sent as plaintext, so please use our encrypted urls (e.g. use urls in the form of https://, not of the form http://). Users with access to multiple sites must use site-specific URLs (e.g. bigcorp.zephyrondemand.com) or append the site parameter to the query string (e.g. &site=bigcorp).

Basic authentication works by dropping an Authorization Token in the request header, so it can also easily be used in environments that don't know how to decode the URL we used in the curl example. For example, on windows with Powershell 3, we can access the Monte-Carlo API with the following incantation

$authString = "john.smith@bigcorp.com" + ':' + "letMeIn"
$encoded = [System.Convert]::ToBase64String(`
                  [System.Text.Encoding]::UTF8.GetBytes($authString))
$headers = @{"Authorization"="Basic $($encoded)";}
Invoke-RestMethod -Uri "https://zephyrondemand.com/api/mc/2?numperiods=5" -Headers $headers `
                  | ConvertTo-JSon

Detailed API Listings