API Documentation

The Notfellchen API serves the purpose of supporting 3rd-person applications, whether you want to display data in a custom format or add data from other sources.

Warning

The current API is limited in it’s functionality. I you miss a specific feature please contact the developers!

API Access

Via browser

When a user is logged in, they can easily access the API in their browser, authenticated by their session. The API endpoint can be found at http://notfellchen.org/api/adoption_notices

Via token

All users are able to generate a token that allows them to use the API. This can be done in the user’s profile. An application can then send this token in the request header for authorization.

Warning

Usage or creation of content still has to follow the terms of Notfellchen.org Copyright of content is often held by rescue organizations, so you are not allowed to simply mirror content. Talk to the Notfellchen-Team if you want develop such things.

Endpoints

Get Adoption Notices

Create Adoption Notice

Add Animal to Adoption Notice

Add picture to Animal or Adoption Notice

Species

Getting available species is mainly important when creating animals