diff --git a/doc/README.md b/doc/README.md index a47f4923..8979780a 100644 --- a/doc/README.md +++ b/doc/README.md @@ -4,12 +4,12 @@ ### Automation key -The authentication of the automation is performed via a secure key available in the AIL UI interface. Make sure you keep that key secret as it gives access to the entire database! The API key is available in the ``Server Management`` menu under ``My Profile``. +The authentication of the automation is performed via a secure key available in the AIL UI interface. Make sure you keep that key secret. It gives access to the entire database! The API key is available in the ``Server Management`` menu under ``My Profile``. The authorization is performed by using the following header: ~~~~ -Authorization: YOUR API KEY +Authorization: YOUR_API_KEY ~~~~ ### Accept and Content-Type headers @@ -22,7 +22,7 @@ Content-Type: application/json Example: ~~~~ -curl --header "Authorization: YOUR API KEY" --header "Content-Type: application/json" https:/// +curl --header "Authorization: YOUR_API_KEY" --header "Content-Type: application/json" https://AIL_URL/ ~~~~ ## Item management @@ -460,5 +460,5 @@ curl -k https://127.0.0.1:7000/api/import/item/b20a69f1-99ad-4cb3-b212-7ce24b763 ```json {"status": "error", "reason": "Invalid uuid"} - {"status": "error", "reason": "Unknow uuid"} + {"status": "error", "reason": "Unknown uuid"} ```