From d6c34f1ef4537d6852164354136fc5bc8c58b2d5 Mon Sep 17 00:00:00 2001 From: Jamie Date: Wed, 27 Sep 2017 08:10:55 +0100 Subject: [PATCH] Created Api Information (markdown) --- Api-Information.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 Api-Information.md diff --git a/Api-Information.md b/Api-Information.md new file mode 100644 index 0000000..25c5c73 --- /dev/null +++ b/Api-Information.md @@ -0,0 +1,12 @@ +You can find the documentation on the API via swagger, http://localhost:5000/swagger + +This will provide you all the documentation about the available API's and how to use it. + +There are two different ways to interact with the API + +* Using JWT Bearer authentication + * This means you need to authenticate with a username and password and you will get a unique token that the application can use to identity that user including all roles. + * You use this by setting an `Authorization` header with the value being `Bearer YOUR_TOKEN`. +* Using the API Key + * You can use the API key that is found in the Ombi settings page of the application. Using the API key provides admin access to the whole system, so keep this a secret. + * You can use this by setting an `ApiKey` header with the value being the API key from the settings page \ No newline at end of file