Changes for page 1. Authorization
Last modified by Giorgi Mdivnishvili on 2024/04/26 15:59
From version 26.1
edited by Giorgi Mdivnishvili
on 2024/01/09 12:45
on 2024/01/09 12:45
Change comment:
There is no comment for this version
To version 31.2
edited by Giorgi Mdivnishvili
on 2024/04/11 15:37
on 2024/04/11 15:37
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -7,9 +7,9 @@ 7 7 {{toc/}} 8 8 {{/box}} 9 9 10 -= MethodDescription =10 += Authorization: Starting Your Integration = 11 11 12 -The i nitialmethod of the integrationprocessis authorization.Youwill beprovidedwithausername and password to generatethe access token thatyouwillneedtopass in allthefollowingmethods.12 +The first step in integrating with our API is the authorization process. As a developer, you'll be assigned a unique username and password. These credentials are essential for generating the access token, a critical component that must be included in the headers of all subsequent API requests. This token validates your requests and grants you access to the full suite of our services. 13 13 14 14 15 15 == Request URL - [POST] == ... ... @@ -42,11 +42,14 @@ 42 42 43 43 {{code language="Json"}} 44 44 { 45 - "accessToken": "string" 45 + "accessToken": "string", 46 + "refreshToken": "string", 47 + "passwordExpired": true 46 46 } 47 47 {{/code}} 48 48 49 49 52 + 50 50 === Schema === 51 51 52 52 (% data-xwiki-non-generated-content="java.util.List" %) ... ... @@ -55,12 +55,13 @@ 55 55 ))) 56 56 57 57 {{success}} 58 -AuthRe quest{61 +AuthResponse{ 59 59 60 -| login|string63 +|accessToken|string 61 61 nullable: true 62 -| password|string65 +|refreshToken|string 63 63 nullable: true 67 +|passwordExpired|boolean 64 64 65 65 } 66 66 {{/success}} ... ... @@ -69,18 +69,18 @@ 69 69 == Important == 70 70 71 71 {{error}} 72 - It'sImportant to in every otherrequestheader, put Auth token76 +=== Implementing Authorization in Subsequent Requests === 73 73 74 - **Key**-Authorization78 +For every API request after the initial authentication, it's crucial to include the authorization token in the request header. This ensures your requests are authorized and can access the necessary resources. Here's how to properly include your token: 75 75 76 -**Value **- Bearer Token what is given in this response. 80 +* **Header Key:** Authorization 81 +* **Header Value:** Bearer [Your Token Here] - Use the bearer token provided in the initial authentication response. The authorization type should be specified as Bearer Token. 77 77 83 +Additionally, to ensure your requests are properly formatted and recognized, include the following headers: 78 78 79 -**also note in headers that:** 85 +* **Content-Type:** Specify this header as application/json to indicate the format of the request body. 86 +* **Header Key:** X-nugios-timezone 87 +* **Header Value:** 240 - Adjust this value to match your local timezone offset in minutes. 80 80 81 -Content-Type - application/json 82 - 83 -**Key - **X-nugios-timezone 84 - 85 -**Value **- 240 89 +Incorporating these headers with their respective values is essential for the successful processing of your API requests. 86 86 {{/error}}