Skip to Content

Changes for page 1. Authorization

Last modified by Giorgi Mdivnishvili on 2024/04/26 15:59
From version 19.1
edited by Giorgi Mdivnishvili
on 2023/12/26 15:03
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
... ... @@ -1,29 +1,22 @@
1 1  (% data-xwiki-non-generated-content="java.util.List" %)
2 2  (((
3 -" data-xwiki-parameter-name="title" class="xwiki-metadata-container">**Contents**
3 +
4 4  )))
5 5  
6 -(% data-xwiki-non-generated-content="java.util.List" %)
7 -(((
8 -" class="xwiki-metadata-container">
9 -
10 -{{toc/}}
11 -)))
12 -
13 13  {{box cssClass="floatinginfobox" title="**Contents**"}}
14 14  {{toc/}}
15 15  {{/box}}
16 16  
17 -= Method Description =
10 += Authorization: Starting Your Integration =
18 18  
19 -The initial method of the integration process is authorization. You will be provided with a  unique user username and password to generate the access token that you will need to pass in all the following methods.
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.
20 20  
21 21  
22 -== Request URL - [GET] ==
15 +== Request URL - [POST] ==
23 23  
24 24  (% class="box infomessage" %)
25 25  (((
26 -https:~/~/online-api.kazunion.com/api/Auth/Auth
19 +[[https:~~/~~/integration.kazunion.com/api/Auth/Auth>>https://integration.kazunion.com/api/Auth/Auth]]
27 27  )))
28 28  
29 29  
... ... @@ -49,72 +49,99 @@
49 49  
50 50  {{code language="Json"}}
51 51  {
52 - "accessToken": "string"
45 + "accessToken": "string",
46 + "refreshToken": "string",
47 + "passwordExpired": true
53 53  }
54 54  {{/code}}
55 55  
56 56  
52 +expiration time 30 days for both tokens:
53 +
54 +accessToken - 43200 min
55 +
56 +refreshToken - 2591968 sec
57 +
58 +
57 57  === Schema ===
58 58  
59 59  (% data-xwiki-non-generated-content="java.util.List" %)
60 60  (((
61 -" class="xwiki-metadata-container">AuthRequest{
62 -
63 -|login|string
64 -nullable: true
65 -|password|string
66 -nullable: true
67 -
68 -}
63 +
69 69  )))
70 70  
71 71  {{success}}
72 -AuthRequest{
67 +AuthResponse{
73 73  
74 -|login|string
69 +|accessToken|string
75 75  nullable: true
76 -|password|string
71 +|refreshToken|string
77 77  nullable: true
73 +|passwordExpired|boolean
78 78  
79 79  }
80 80  {{/success}}
81 81  
82 82  
83 -== Important ==
84 84  
85 -(% data-xwiki-non-generated-content="java.util.List" %)
86 -(((
87 -" class="xwiki-metadata-container">It's Important to in every other request header, put Auth token
88 88  
89 -**Key **- Authorization
81 += RefreshToken =
90 90  
91 -**Value **- Bearer Token what is given in this response.
92 92  
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.
93 93  
94 -**also note in headers that:**
95 95  
96 -Content-Type - application/json
87 +== Request URL - [POST] ==
97 97  
98 -**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 +)))
99 99  
100 -**Value **- 240
94 +
95 +== Request Parameters ==
96 +
97 +(% class="box" %)
98 +(((
99 +none
101 101  )))
102 102  
103 -{{error}}
104 -It's Important to in every other request header, put Auth token
105 105  
106 -**Key **- Authorization
103 +== (% id="cke_bm_5539S" style="display:none" %) (%%)Request Body example ==
107 107  
108 -**Value **- Bearer Token what is given in this response.
105 +{{code language="Json"}}
106 +{
107 + "refreshToken": "string"
108 +}
109 +{{/code}}
109 109  
110 110  
111 -**also note in headers that:**
112 +== (% id="cke_bm_11208S" style="display:none" %) (%%)Response Body ==
112 112  
113 -Content-Type - application/json
114 +{{code language="Json"}}
115 +{
116 + "accessToken": "string",
117 + "refreshToken": "string",
118 + "passwordExpired": true
119 +}
120 +{{/code}}
114 114  
115 -**Key - **X-nugios-timezone
116 116  
117 -**Value **- 240
118 -{{/error}}
123 +== Important ==
119 119  
120 -
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.
140 +{{/error}}