summaryrefslogtreecommitdiffstats
path: root/documentation/api/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/api/README.md')
-rw-r--r--documentation/api/README.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/documentation/api/README.md b/documentation/api/README.md
index d1e88e3..c617844 100644
--- a/documentation/api/README.md
+++ b/documentation/api/README.md
@@ -1,21 +1,21 @@
# Getting Started
-The Api can be called under the following address:
+The API can be called under the following address:
```
https://<domain_bss>/api/
```
The collections and resources are described in the [Collections](/api/collections.md) section.
## Authorization
-Some collections need authentication while other can be called without.
-To authenticate a request you have to send the json web token to the backend.\
-There are two way to do so
+Some collections need authentication while others can be called without.
+To authenticate a request you have to send the JSON web token to the backend.\
+There are two ways to do so
* **Authorization Header**\
Set the *Bearer* token in the *Authorization* header.
```
Authorization: Bearer <jsonwebtoken>
```
-> **\<jsonwebtoken\>** - Full json web token in the form header.payload.signature.
+> **\<jsonwebtoken\>** - Full JSON web token in form of header.payload.signature.
* **Cookies**\
To prevent that the Javascript code of the website has access to the full jwt the token is splitted in two seperate cookies.
@@ -25,12 +25,12 @@ To prevent that the Javascript code of the website has access to the full jwt th
To get the token use the login method from the [api/authentication](/api/collections.html#authentication).
## Return values
-The API returns data always in JSON format.
+The API always returns data in JSON format.
If the request was successfull it will return status code 200 and the requested data.
* [200 - OK](https://httpstatuses.com/200)\
-Request was successfull. Optional the response has an json object with the data included.
+Request was successfull. Optional the response has a JSON object with the data included.
-If a request is not successfull it will set a html status code and return a json object with a status and an error message included.
+If a request is not successfull it will set a HTML status code and return a JSON object with a status and an error message included.
```json
{
"error": "",