Changes for page 1. Authorization
Last modified by Giorgi Mdivnishvili on 2024/04/26 15:59
From version 27.1
edited by Giorgi Mdivnishvili
on 2024/01/09 14:19
on 2024/01/09 14:19
Change comment:
There is no comment for this version
To version 34.1
edited by Giorgi Mdivnishvili
on 2024/04/26 15:58
on 2024/04/26 15:58
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,12 +42,20 @@ 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 +expiration time 30 days for both tokens: 50 50 54 +accessToken - 43200 min 55 + 56 +refreshToken - 2591968 sec 57 + 58 + 51 51 === Schema === 52 52 53 53 (% data-xwiki-non-generated-content="java.util.List" %) ... ... @@ -56,32 +56,82 @@ 56 56 ))) 57 57 58 58 {{success}} 59 -AuthRe quest{67 +AuthResponse{ 60 60 61 -| login|string69 +|accessToken|string 62 62 nullable: true 63 -| password|string71 +|refreshToken|string 64 64 nullable: true 73 +|passwordExpired|boolean 65 65 66 66 } 67 67 {{/success}} 68 68 69 69 70 -== Important == 71 71 72 -{{error}} 73 -It's Important to in every other request header, put Auth token 74 74 75 -**Key **- Authorization 76 76 77 -**Value **- Bearer Token what is given in this response. (Authorization type Bearer Token) 78 78 83 += RefreshToken = 79 79 80 -**also note in headers that:** 81 81 82 - Content-Type-application/json86 +To retrieve an existing accesstoken , you can make a request for the given endpoint below and pass in the body refreshToken, after that you will receive an accessToken. You can use this method at your discretion. 83 83 84 -**Key - **X-nugios-timezone 85 85 86 -**Value **- 240 89 +== Request URL - [POST] == 90 + 91 +(% class="box infomessage" %) 92 +((( 93 +[[https:~~/~~/integration.kazunion.com/api/Auth/RefreshToken>>https://integration.kazunion.com/api/Auth/RefreshToken]] 94 +))) 95 + 96 + 97 +== Request Parameters == 98 + 99 +(% class="box" %) 100 +((( 101 +none 102 +))) 103 + 104 +== == 105 + 106 +== (% id="cke_bm_5539S" style="display:none" %) (%%)Request Body example == 107 + 108 +{{code language="Json"}} 109 +{ 110 + "refreshToken": "string" 111 +} 112 +{{/code}} 113 + 114 + 115 +== (% id="cke_bm_11208S" style="display:none" %) (%%)Response Body == 116 + 117 +{{code language="Json"}} 118 +{ 119 + "accessToken": "string", 120 + "refreshToken": "string", 121 + "passwordExpired": true 122 +} 123 +{{/code}} 124 + 125 + 126 +== == 127 + 128 +== Important == 129 + 130 +{{error}} 131 +=== Implementing Authorization in Subsequent Requests === 132 + 133 +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: 134 + 135 +* **Header Key:** Authorization 136 +* **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. 137 + 138 +Additionally, to ensure your requests are properly formatted and recognized, include the following headers: 139 + 140 +* **Content-Type:** Specify this header as application/json to indicate the format of the request body. 141 +* **Header Key:** X-nugios-timezone 142 +* **Header Value:** 240 - Adjust this value to match your local timezone offset in minutes. 143 + 144 +Incorporating these headers with their respective values is essential for the successful processing of your API requests. 87 87 {{/error}}