Changes for page 1. Authorization

Last modified by Giorgi Mdivnishvili on 2024/04/26 15:59

From version 29.1
edited by Giorgi Mdivnishvili
on 2024/04/11 15:33
Change comment: There is no comment for this version
To version 35.1
edited by Giorgi Mdivnishvili
on 2024/04/26 15:59
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -7,11 +7,8 @@
7 7  {{toc/}}
8 8  {{/box}}
9 9  
10 -= Method Description =
10 += Authorization: Starting Your Integration =
11 11  
12 -
13 -== Authorization: Starting Your Integration ==
14 -
15 15  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.
16 16  
17 17  
... ... @@ -45,12 +45,20 @@
45 45  
46 46  {{code language="Json"}}
47 47  {
48 - "accessToken": "string"
45 + "accessToken": "string",
46 + "refreshToken": "string",
47 + "passwordExpired": true
49 49  }
50 50  {{/code}}
51 51  
52 52  
52 +expiration time 30 days for both tokens:
53 53  
54 +accessToken - 43200 min
55 +
56 +refreshToken - 2591968 sec
57 +
58 +
54 54  === Schema ===
55 55  
56 56  (% data-xwiki-non-generated-content="java.util.List" %)
... ... @@ -59,32 +59,77 @@
59 59  )))
60 60  
61 61  {{success}}
62 -AuthRequest{
67 +AuthResponse{
63 63  
64 -|login|string
69 +|accessToken|string
65 65  nullable: true
66 -|password|string
71 +|refreshToken|string
67 67  nullable: true
73 +|passwordExpired|boolean
68 68  
69 69  }
70 70  {{/success}}
71 71  
72 72  
73 -== Important ==
74 74  
75 -{{error}}
76 -It's Important to in every other request header, put Auth token
77 77  
78 -**Key **- Authorization
81 += RefreshToken =
79 79  
80 -**Value **- Bearer Token what is given in this response. (Authorization type Bearer Token)
81 81  
84 +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.
82 82  
83 -**also note in headers that:**
84 84  
85 -Content-Type - application/json
87 +== Request URL - [POST] ==
86 86  
87 -**Key - **X-nugios-timezone
89 +(% class="box infomessage" %)
90 +(((
91 +[[https:~~/~~/integration.kazunion.com/api/Auth/RefreshToken>>https://integration.kazunion.com/api/Auth/RefreshToken]]
92 +)))
88 88  
89 -**Value **- 240
94 +
95 +== Request Parameters ==
96 +
97 +(% class="box" %)
98 +(((
99 +none
100 +)))
101 +
102 +
103 +== (% id="cke_bm_5539S" style="display:none" %) (%%)Request Body example ==
104 +
105 +{{code language="Json"}}
106 +{
107 + "refreshToken": "string"
108 +}
109 +{{/code}}
110 +
111 +
112 +== (% id="cke_bm_11208S" style="display:none" %) (%%)Response Body ==
113 +
114 +{{code language="Json"}}
115 +{
116 + "accessToken": "string",
117 + "refreshToken": "string",
118 + "passwordExpired": true
119 +}
120 +{{/code}}
121 +
122 +
123 +== Important ==
124 +
125 +{{error}}
126 +=== Implementing Authorization in Subsequent Requests ===
127 +
128 +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:
129 +
130 +* **Header Key:** Authorization
131 +* **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.
132 +
133 +Additionally, to ensure your requests are properly formatted and recognized, include the following headers:
134 +
135 +* **Content-Type:** Specify this header as application/json to indicate the format of the request body.
136 +* **Header Key:** X-nugios-timezone
137 +* **Header Value:** 240 - Adjust this value to match your local timezone offset in minutes.
138 +
139 +Incorporating these headers with their respective values is essential for the successful processing of your API requests.
90 90  {{/error}}