Skip to Content

Changes for page 1. Authorization

Last modified by Giorgi Mdivnishvili on 2024/04/26 15:59
From version 31.1
edited by Giorgi Mdivnishvili
on 2024/04/11 15:36
Change comment: There is no comment for this version
To version 23.1
edited by Giorgi Mdivnishvili
on 2023/12/26 16:38
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 -= Authorization: Starting Your Integration =
10 += Method Description =
11 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.
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.
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://integration.kazunion.com/api/Auth/Auth]]
19 +[[https:~~/~~/online-api.kazunion.com/api/Auth/Auth>>https://online-api.kazunion.com/api/Auth/Auth]]
20 20  )))
21 21  
22 22  
... ... @@ -42,29 +42,32 @@
42 42  
43 43  {{code language="Json"}}
44 44  {
45 - "accessToken": "string",
46 - "refreshToken": "string",
47 - "passwordExpired": true
45 + "accessToken": "string"
48 48  }
49 49  {{/code}}
50 50  
51 51  
52 -
53 53  === Schema ===
54 54  
55 55  (% data-xwiki-non-generated-content="java.util.List" %)
56 56  (((
57 -
54 +" class="xwiki-metadata-container">AuthRequest{
55 +
56 +|login|string
57 +nullable: true
58 +|password|string
59 +nullable: true
60 +
61 +}
58 58  )))
59 59  
60 60  {{success}}
61 -AuthResponse{
65 +AuthRequest{
62 62  
63 -|accessToken|string
67 +|login|string
64 64  nullable: true
65 -|refreshToken|string
69 +|password|string
66 66  nullable: true
67 -|passwordExpired|boolean
68 68  
69 69  }
70 70  {{/success}}
... ... @@ -73,18 +73,18 @@
73 73  == Important ==
74 74  
75 75  {{error}}
76 -=== Implementing Authorization in Subsequent Requests ===
79 +It's Important to in every other request header, put Auth token
77 77  
78 -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:
81 +**Key **- Authorization
79 79  
80 -* **Header Key:** Authorization
81 -* **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.
83 +**Value **- Bearer Token what is given in this response.
82 82  
83 -Additionally, to ensure your requests are properly formatted and recognized, include the following headers:
84 84  
85 -* **Content-Type:** Specify this header as application/json to indicate the format of the request body.
86 -* **Header Key:** X-nugios-timezone
87 -* **Header Value:** 240 - Adjust this value to match your local timezone offset in minutes.
86 +**also note in headers that:**
88 88  
89 -Incorporating these headers with their respective values is essential for the successful processing of your API requests.
88 +Content-Type - application/json
89 +
90 +**Key - **X-nugios-timezone
91 +
92 +**Value **- 240
90 90  {{/error}}