EasyVerein API documentation

This is the official documentation of the easyVerein API. You can navigate to the version specific documentations below.

What the easyVerein API is capable of

With the help of this API it is possible to build a much more independent application form than with the one allready known.

To do that the association can build its own formular on their website and send the information that are typed in there over the api to easyVerein. This is done with the help of the API-Token generated for the association. You can generate one here.

But the possibilities of an API (or better this API) doesn't end there, its also possible to automate the invoices with the API, do some one time collection activities or manage members and addresses. In principle its possible to do almost everything thats possible with the normal UI except for exporting/importing.

The possibilities are nearly endless, the whole easyVerein app (except the video meetings) is based on the API and therefore nothing more than just an client for the easyVerein service.

Beta

Please note that the easyVerein API is still a beta which means that it doesn't provide all API endpoints by now. Support and warranty are limited. We will expand the API and release more endpoints within the next months.

If you want to get rid of the versioning, you can alternatively use the terms /stable and /latest to always use the latest or stable version of the API. Please note that it is possible that versions are different with handling requests, so the latest and stable terms may cause some trouble.

FAQ

An application programming interface (API) is a way for two or more computer programs to communicate with each other. It is a type of software interface, offering a service to other pieces of software.

In contrast to a user interface, which connects a computer to a person, an application programming interface connects computers or pieces of software to each other. It is not intended to be used directly by a person (the end user) other than a computer programmer who is incorporating it into the software.

Source

An Api is used to connect pieces of software. This means that this Api is used to manipulate, query, create or delete certain entries inside a database from another software. Moreover, this Api handles validation and can trigger some special functions for easyVerein.

To simply awnser the querstion: You should use this Api to interact with your data inside easyVerein.

You should not use the Api to extract data from easyVerein. This is not the usecase of any Api. Use the export function of easyVerein instead.

Please consider our FAQ

There are two different ways to ship software updates to the user: roaling release and stable versioning. We prefer the last one. This means that we develop (making changes, sometimes even breaking changes) only in the newest version that is marked as latest. The version marked as stable is save to use. There should be no crashes.

This are the versions that are currently available:

Documentation for API v1.6 Documentation for API v1.7