Home

Download this help site
(PDF 82MB)

Download

Wild Apricot API Version 2

Icon

Wild Apricot's API is intended for use by developers with technical expertise. If you need assistance, we provide support via email or through our Developers forum.

Icon

By using Wild Apricot's API, you accept the API License Agreement.

About Wild Apricot's API

An API – Application Programming Interface – is a set of functions that allow programs to interact with each other. With Wild Apricot's API, you can create programs to automatically retrieve and update data stored in your Wild Apricot database.  Version 1 of Wild Apricot's API can be used only to retrieve information, while Version 2 now provides the ability to update contact information, event registration, and payments, along with a number of new API calls you can use to retrieve additional information.

An API consists of a number of API calls, each of which performs a specific function. For example, Wild Apricot's MembershipLevels API call allows you to retrieve detailed information about your membership levels. As part of an API call, you can include parameters, which are instructions or information used by the API to process your request.

For a complete list of Version 2 API calls, see API V2 calls.

Icon

Using API calls to retrieve data from Wild Apricot databases requires significant programming knowledge. If you want to take advantage of this functionality but lack the technical knowledge, you can engage the services of an approved Wild Apricot partner. To see how Wild Apricot's API works without having to write any code, you can use Wild Apricot's API browser, a JavaScript application embedded in a help topic.

Using Wild Apricot's API

Wild Apricot's API can be accessed from a 3rd-party server or application, or from a Wild Apricot site page. For information on differences between the two, see API access options.

Wild Apricot's API adheres to  RESTful web service principles Version 2 API calls take the form of HTML GET, PUT, POST, or DELETE requests formatted in either JSON (JavaScript Object Notation) or XML (Extensible Markup Language). Multiple API requests can be combined in a   single batch request using the BATCH method.

Authentication

Each Wild Apricot API call must include authentication information that  verifies  your account and prevents others from accessing your data. The required authentication information – and how it is passed – differs depending on whether you are accessing the API from a 3rd party server or application, or from a Wild Apricot site page. For information on authenticating server-side access, see  Authenticating API access from a 3rd-party server or application For information on authenticating client-side access, see Authenticating API access from a Wild Apricot site page.

Versioning

The version number of the Wild Apricot API is included in the API call to allow existing applications to function after new versions are released.

In the following example, the v2 value directs the call to version 2 of the Wild Apricot API.

A call to the base APIhttps://api.wildapricot.org – will return a list of available API versions.

API responses

Results from Wild Apricot API calls can be returned in either JSON (JavaScript Object Notation) or XML (Extensible Markup Language) formats. The default format is JSON.

To specify the response format, include the following field in the HTTP header:

where {format} can be either json or xml.

You can compress the response by including the following field in the HTTP header:

For more information on compressing data in server responses, see HTTP compression.

API request limits

Currently, the limits on the number API request per minute are:

  • 20 requests involving multiple contacts
  • 60 requests involving single contacts
  • 200 other requests.

Transitioning from API Version 1

You should keep the following in mind when you transition your application from Version 1 of the Wild Apricot's API to Version 2.

  • Version 2 of Wild Apricot API's uses the OAuth authentication standard and issues OAuth authentication tokens. With Version 2, server-side authentication is a two-step process. In the first step, the client application requests an authentication token from the authentication server. In the second step, the authentication server returns an authentication token, which the client application uses in the API call.

    When accessing version 2 of Wild Apricot's API, an 3rd-party server or application must first be authorized to access your Wild Apricot account. During authorization, the application will be assigned a unique API key. Using the API key, your application can request an authentication token. For more information, see Authenticating API access from a 3rd-party server or application.

  • The root node for an XML response to an asynchronous Contacts API call is now  ApiResponse. With Version 1, it was AsyncResult. 

 

On this page:  

See also:


  • No labels