Created Api Information (markdown)

master
Jamie 8 years ago
parent 41a90a1716
commit d6c34f1ef4

@ -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
Loading…
Cancel
Save