Getting Started

Create a Partner Account

This documentation is for the Engine Yard Add-on APIs. Before you may use any of these APIs, you must signup as an Engine Yard partner. The steps are:

  1. Login to your Engine Yard user account (or create a new one):
  2. Login to your Engine Yard cloud account (or create a new one):
  3. Login to your Engine Yard Add-ons partners account (or create a new one):

Choosing the right API

Engine Yard maintains two different sets of APIs to address the different needs of a diverse community of Add-on developers.

If you have already integrated your application with other leading Marketplaces (Heroku, AppHarbor etc. ) or are planning on doing so at some point in the future, you should consider using the Haiku API, which is based on a the open-source Kensa SDK.

If you have already integrated your application as an Engine Yard Add-on as of Dec. 12, 2013, you are using the Sonnet API. Sonnet is designed to be a more flexible API for Add-ons that don't fit well within the Kensa model. However, with the flexibility comes some added complexity. Also it is an Engine Yard proprietary API, so you may not be able to leverage your work with other Marketplaces. We plan to continue to support Sonnet going forward.

The major API differences include:

  • The Haiku API requires that you pre-define your available plans. The customer must choose a plan on each activation of the Add-on, which Engine Yard will use to calculate invoices. Sonnet, by contrast, expects plan selection to occur in your own UI, via SSO, and you use API calls to submit Invoices.
  • The Sonnet API requires an extra step from customers who signup. First they enable your Add-on at the Account level, Then they activate it any number of times for their App-Environments. Some Add-on providers (such as those that aren't providing customized configuration variables to customer apps) find that Account level only integration is the best thing. This is only possible with Sonnet.

More on the unique features of each API are in the API documentation links on this page.