From 350ce70ef01cd782a3a39668977bc4b35f3fabf1 Mon Sep 17 00:00:00 2001 From: Martin Date: Mon, 15 Aug 2016 17:15:39 +0200 Subject: [PATCH] auth moved to docs --- README.md | 7 ------- docs/README.md | 8 ++++++++ 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 611d229..c81ebf4 100644 --- a/README.md +++ b/README.md @@ -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: diff --git a/docs/README.md b/docs/README.md index 1e0d598..af03112 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 \ No newline at end of file