2023-03-30 06:28:23 +00:00
|
|
|
# Testing the API
|
|
|
|
|
|
2023-03-30 06:29:07 +00:00
|
|
|
These scripts can be used to test almost all endpoints of the
|
2023-03-30 06:28:23 +00:00
|
|
|
paperless-ngx API.
|
|
|
|
|
|
|
|
|
|
In order to use them, create a file `credentials` and define `AUTH` and
|
|
|
|
|
`URL` in it. `URL` is the base url of the restapi service. `AUTH` are the
|
|
|
|
|
credentials passed in the http header `Authorization`. It can be a basic
|
|
|
|
|
authentication, a paperless token or a regular SeedDMS key.
|
2023-01-20 14:21:01 +00:00
|
|
|
|
2023-03-30 05:16:14 +00:00
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
URL="http://my.seeddms.org/restapi/index.php"
|
2023-03-30 06:28:23 +00:00
|
|
|
AUTH="my seeddms api key"
|
|
|
|
|
#AUTH="Token <paperless token>"
|
|
|
|
|
#AUTH="Basic <credentials>"
|
2023-03-30 05:16:14 +00:00
|
|
|
|
