{% extends 'api/doc/base.html' %} {% load markup %} {% block form_content %}

Welcome to the {{ SITE.name }} API

{{ SITE.name }} uses a RESTful API. If you’re not familiar with it, you can read the Wikipedia entry on the topic. In short however, you can perform four types of action via the {{ SITE.name }} REST API:

GET
Return a single record or a list of records
POST
Create a new record
PUT
Update an existing record
DELETE
Remove a record

There are a number of API endpoints divided up into sections. Please use the Endpoints menu to find your way around.

{% if auth %}

{{ auth.name }}

{{ auth.doc|restructuredtext }} {% endif %} {% endblock form_content %}