API (application programming interface)
Commercial Use
The API enables you to access your WebCollect data from another programme, for example, from your WordPress website. The common reasons for using this are:
- To pass data to your website database about whether a member has a current paid up subscription. Useful if you restrict access to certain parts of your website to "members only".
- Data back-up. You can download your membership and subscription data from WebCollect at any time as csv files. The API allows you to schedule automatic back-ups, and to retrieve and store the data as linked tables in a database, as opposed to separate extracts.
The API now includes events and event bookings.
Techy Summary
The API is a "read-only RESTful interface to deliver member, membership form, address, subscription and subscription form data as an array of json objects. You can query all members or a specific member by email address."
The API can be used with any technology or programming language, as it uses open standards.
There is a sample client in PHP which can be downloaded. The relevant information for using it with a technology other than php is contained in a README file in the download. If you write a sample code in another language, please send us a copy and we will add it to the library.
How to Access
You will need to provide your technical developer with access to the administration panel.
In the administration panel, click on the link Manage API tokens in the Connect WebCollect section. There you will find the sample clients for download, and can generate access tokens.
Please download the README file within the sample clients, for a full explanation on how to:
- generate tokens, edit and run the client files
- retrieve all members
- query a single member
