Skip to Content

Changes for page 1. Authorization

Last modified by Giorgi Mdivnishvili on 2024/04/26 15:59
From version 24.1
edited by Giorgi Mdivnishvili
on 2024/01/09 07:11
Change comment: There is no comment for this version
To version 33.1
edited by Giorgi Mdivnishvili
on 2024/04/16 18:43
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -7,9 +7,9 @@
7 7  {{toc/}}
8 8  {{/box}}
9 9  
10 -= Method Description =
10 += Authorization: Starting Your Integration =
11 11  
12 -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.
13 13  
14 14  
15 15  == Request URL - [POST] ==
... ... @@ -16,7 +16,7 @@
16 16  
17 17  (% class="box infomessage" %)
18 18  (((
19 -[[https:~~/~~/integration.kazunion.com/api/Auth/Auth>>https://online-api.kazunion.com/api/Auth/Auth]]
19 +[[https:~~/~~/integration.kazunion.com/api/Auth/Auth>>https://integration.kazunion.com/api/Auth/Auth]]
20 20  )))
21 21  
22 22  
... ... @@ -42,32 +42,35 @@
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:
53 +
54 +accessToken - 43200 min
55 +
56 +refreshToken - 2591968 sec
57 +
58 +
50 50  === Schema ===
51 51  
52 52  (% data-xwiki-non-generated-content="java.util.List" %)
53 53  (((
54 -" class="xwiki-metadata-container">AuthRequest{
55 -
56 -|login|string
57 -nullable: true
58 -|password|string
59 -nullable: true
60 -
61 -}
63 +
62 62  )))
63 63  
64 64  {{success}}
65 -AuthRequest{
67 +AuthResponse{
66 66  
67 -|login|string
69 +|accessToken|string
68 68  nullable: true
69 -|password|string
71 +|refreshToken|string
70 70  nullable: true
73 +|passwordExpired|boolean
71 71  
72 72  }
73 73  {{/success}}
... ... @@ -76,18 +76,18 @@
76 76  == Important ==
77 77  
78 78  {{error}}
79 -It's Important to in every other request header, put Auth token
82 +=== Implementing Authorization in Subsequent Requests ===
80 80  
81 -**Key **- Authorization
84 +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:
82 82  
83 -**Value **- Bearer Token what is given in this response.
86 +* **Header Key:** Authorization
87 +* **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.
84 84  
89 +Additionally, to ensure your requests are properly formatted and recognized, include the following headers:
85 85  
86 -**also note in headers that:**
91 +* **Content-Type:** Specify this header as application/json to indicate the format of the request body.
92 +* **Header Key:** X-nugios-timezone
93 +* **Header Value:** 240 - Adjust this value to match your local timezone offset in minutes.
87 87  
88 -Content-Type - application/json
89 -
90 -**Key - **X-nugios-timezone
91 -
92 -**Value **- 240
95 +Incorporating these headers with their respective values is essential for the successful processing of your API requests.
93 93  {{/error}}