Welcome! If you are reading this page you are probably interested in writing software that uses the Zermelo API. If not, you probably want to visit the main Zermelo site.
The API is the core of Zermelo 3 and of the vision of Zermelo to improve the ease of sharing information. It is a JSON REST API. In order to access the API you need an endpoint and an access token. Both will have to be provided by the customer/user himself. If you're affiliated with a school it is usually possible to use that portal for testing. Otherwise Zermelo may be able provide you with a Zermelo Portal account.
An example endpoint would be: "https://somename.zportal.nl/api" while an example token is: "a4pp9gg34g3u89p5qd96samrok".
When you use the endpoint you need to append the version you are using. The current API version is v3. For information about API versions check out API Versions & Changelog.
If you want to retrieve as schedule first read General API Information. and then take a look at Retrieving the schedule with Curl. For detailed information you can consult Appointment. Also make sure to read Making your Zermelo API project a success. If you want to know how to use our software you can consult the Handleiding (in Dutch). We hope that we'll be able to be able to add your project to Projects using the API soon!
If you have any questions or comments please don't hesitate to contact us at firstname.lastname@example.org.
Please subscribe to the mailing list so we can keep you posted on changes to the API.
- General API Information
- Making your Zermelo API project a success
- API Versions & Changelog
- Common Tasks
- API Authentication
- API Entities
- Projects using the API