Skip to Content

Wiki source code of 1. Authorization

Version 34.1 by Giorgi Mdivnishvili on 2024/04/26 15:58
Show last authors
1 (% data-xwiki-non-generated-content="java.util.List" %)
2 (((
3
4 )))
5
6 {{box cssClass="floatinginfobox" title="**Contents**"}}
7 {{toc/}}
8 {{/box}}
9
10 = Authorization: Starting Your Integration =
11
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
14
15 == Request URL - [POST] ==
16
17 (% class="box infomessage" %)
18 (((
19 [[https:~~/~~/integration.kazunion.com/api/Auth/Auth>>https://integration.kazunion.com/api/Auth/Auth]]
20 )))
21
22
23 == Request Parameters ==
24
25 (% class="box" %)
26 (((
27 none
28 )))
29
30
31 == Request Body ==
32
33 {{code language="Json"}}
34 {
35 "login": "string",
36 "password": "string"
37 }
38 {{/code}}
39
40
41 == Response Body ==
42
43 {{code language="Json"}}
44 {
45 "accessToken": "string",
46 "refreshToken": "string",
47 "passwordExpired": true
48 }
49 {{/code}}
50
51
52 expiration time 30 days for both tokens:
53
54 accessToken - 43200 min
55
56 refreshToken - 2591968 sec
57
58
59 === Schema ===
60
61 (% data-xwiki-non-generated-content="java.util.List" %)
62 (((
63
64 )))
65
66 {{success}}
67 AuthResponse{
68
69 |accessToken|string
70 nullable: true
71 |refreshToken|string
72 nullable: true
73 |passwordExpired|boolean
74
75 }
76 {{/success}}
77
78
79
80
81
82
83 = RefreshToken =
84
85
86 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.
87
88
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.
145 {{/error}}