auth moved to docs

This commit is contained in:
Martin
2016-08-15 17:15:39 +02:00
parent e7722aee9b
commit 350ce70ef0
2 changed files with 8 additions and 7 deletions
-7
View File
@@ -37,13 +37,6 @@ List of available configuration options:
| `ESALES_URL` | URL to the eSales server. If its a cloud cluster it has the format `username:password` |
| `ESALES_IMPORT_DIR` | XML-files that should be imported to eSales are temporarily stored in this directory. e.g: `/tmp/esales`
## Authentication
Authentication to the API is performed via HTTP Basic Auth. The user should provide her API key as the basic auth username parameter. An example request in cURL looks like this (adding a colon after the username prevents cURL from asking for a password):
```
$ curl http://localhost:5000/designers/ -u mykey:
```
API keys should be added to the `API_KEYS` configuration option
## Getting started
Starting the application:
+8
View File
@@ -5,3 +5,11 @@ Welcome to the documentation for Photowall API 2.
## Resources
* [Prices](prices.md)
## Authentication
Authentication to the API is performed via HTTP Basic Auth. The user should provide her API key as the basic auth username parameter. An example request in cURL looks like this (adding a colon after the username prevents cURL from asking for a password):
```
$ curl http://localhost:5000/designers/ -u mykey:
```
API keys should be added to the `API_KEYS` configuration option