Home

Download this help site
(PDF 82MB)

Download

API access options

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.

Wild Apricot's API supports access from a 3rd party server or application, or from a Wild Apricot site page. 

From 3rd party server/application

Using Wild Apricot API calls, a 3rd-party server or application can retrieve, display, and update information stored in your Wild Apricot database.

The same base API address –   https://api.wildapricot.org/ – is used for calls from 3rd-party servers and applications, including those placed by mobile applications. A Base API call will retrieve a list of API versions. If you add the version number to the base API call, a list of top-level API calls will be returned.

Only  encrypted  HTTP requests – ones that begin with  https – are supported for calls from 3rd-party servers or applications. Insecure requests – ones that begin with  http  – are not supported.

Each Wild Apricot API call must include authentication information that verifies your account and prevents others from accessing your data. For more information, see  Authenticating API access from a 3rd-party server or application

From a Wild Apricot site page

Using Version 2 of Wild Apricot's API, you can embed JavaScript code in your Wild Apricot site pages that uses Wild Apricot API calls to retrieve, display, and update Wild Apricot database information.

An account-specific URL is used to access Wild Apricot's API from Wild Apricot site pages:

where your_account_url is your Wild Apricot domain name.

When accessing the account-specific URL using JavaScript, the protocol should match the protocol currently being used by the browser, so the best choice is  to use relative URLs in the API call. 

For example, instead of:

you would use:

Within your code, access to your Wild Apricot data is limited by the access permissions of the currently authenticated user. Consequently, the API cannot be accessed within public pages that do not require user authentication.

Each Wild Apricot API call must include authentication information that verifies  your account and prevents others from accessing your data.  For information, see  Authenticating API access from a Wild Apricot site page .

Comparing access options

The following summarizes the differences between the two access options.

 3rd-party server/applicationWild Apricot site page
Base API addresshttps://api.wildapricot.org/http://your_account_url/sys/api/
where your_account_url is your Wild Apricot domain name 
Supported protocolsHTTPSHTTP, HTTPS
Access permissionsDepends on authentication methodThose of the currently authenticated user
Access fromExternal server/applicationWild Apricot site page
Sample usesServer-to-server scenarios
Mobile/desktop applications 
Use JavaScript for custom display of Wild Apricot data

On this page: 

  • No labels