Endpoint Reference

Intro

Every API call needs to be authorized using an access token from an supported OAuth2.0 provider. Learn more on how to make an authorized request.

Endpoint Reference List

Method	Endpoint	Parameter	Usage	Returns
GET	/api/user/me	eisLS	Authenticate an user and make sure he exists in the database	User*, [Upload]*
GET	/api/upload	eisLS	Get a list of uploads for a user	User*, [Upload]*
GET	/api/upload/{id}	eis	Get informations about a single upload	Upload, User*
POST	/api/upload/	eis	Upload a new upload	Upload, User*

Explanations

The Endpoint Reference List contains all callable API URLs. For a quicker overview a few abbreviations are being used.

Parameter

eisLS stands for exclude, include, select, limit, skip. You can use any of the assigned parameters in the URL of your request to modify the response.

eis is available everywhere.

• ?exclude=key removes key from the response object
• ?include=key.sub includes sub in a nested object back to the response, when it was removed
• ?select=key is a shorthand vor ?exclude=all&include=key
• You don't have to respect arrays. Just pretend it would be one single item of the array as a object.

LS is available when the response contains a list.

• ?limit=5 limits the list to 5 items (default: 10)
• ?skip=5 skips the first 5 items, before applying limit (default: 0)

Returns

This gives you a quick overview which objects you will get when perform a action.

• ObjA, ObjB: Both ObjA and ObjB are in the first level of the response object.
• ObjA, ObjB*: ObjA will be in the first level, ObjB in a second level of the response object.
• ObjA, [ObjB]*: ObjA will be in the first level, ObjB is an array in the second level of the response object.