2016-03-04 23:59:13 +00:00
|
|
|
|
2020-11-13 18:46:19 +01:00
|
|
|
************
|
2016-03-04 23:59:13 +00:00
|
|
|
The REST API
|
2020-11-13 18:46:19 +01:00
|
|
|
************
|
|
|
|
|
|
|
|
|
|
.. warning::
|
|
|
|
|
|
|
|
|
|
This section is not updated yet.
|
2016-03-04 23:59:13 +00:00
|
|
|
|
|
|
|
|
Paperless makes use of the `Django REST Framework`_ standard API interface
|
|
|
|
|
because of its inherent awesomeness. Conveniently, the system is also
|
2016-03-12 20:45:13 +00:00
|
|
|
self-documenting, so to learn more about the access points, schema, what's
|
2016-03-04 23:59:13 +00:00
|
|
|
accepted and what isn't, you need only visit ``/api`` on your local Paperless
|
|
|
|
|
installation.
|
|
|
|
|
|
|
|
|
|
.. _Django REST Framework: http://django-rest-framework.org/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Uploading
|
2020-11-13 18:46:19 +01:00
|
|
|
=========
|
2016-03-04 23:59:13 +00:00
|
|
|
|
|
|
|
|
File uploads in an API are hard and so far as I've been able to tell, there's
|
|
|
|
|
no standard way of accepting them, so rather than crowbar file uploads into the
|
|
|
|
|
REST API and endure that headache, I've left that process to a simple HTTP
|
2020-11-13 19:27:22 +01:00
|
|
|
POST.
|
