Skip to Content

Changes for page 1. Authorization

Last modified by Giorgi Mdivnishvili on 2024/04/26 15:59
From version 9.1
edited by Giorgi Mdivnishvili
on 2023/12/14 07:48
Change comment: There is no comment for this version
To version 31.1
edited by Giorgi Mdivnishvili
on 2024/04/11 15:36
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Authorization
1 +1. Authorization
Content
... ... @@ -1,17 +1,22 @@
1 +(% data-xwiki-non-generated-content="java.util.List" %)
2 +(((
3 +
4 +)))
5 +
1 1  {{box cssClass="floatinginfobox" title="**Contents**"}}
2 2  {{toc/}}
3 3  {{/box}}
4 4  
5 -= Method Description =
10 += Authorization: Starting Your Integration =
6 6  
7 -The initial method of the integration process is authorization. You will be provided with a test 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.
8 8  
9 9  
10 -== Request URL - [GET] ==
15 +== Request URL - [POST] ==
11 11  
12 12  (% class="box infomessage" %)
13 13  (((
14 -https:~/~/online-api.kazunion.com/api/Auth/Auth
19 +[[https:~~/~~/integration.kazunion.com/api/Auth/Auth>>https://integration.kazunion.com/api/Auth/Auth]]
15 15  )))
16 16  
17 17  
... ... @@ -33,24 +33,53 @@
33 33  {{/code}}
34 34  
35 35  
36 -
37 37  == Response Body ==
38 38  
39 39  {{code language="Json"}}
40 40  {
41 - "accessToken": "string"
45 + "accessToken": "string",
46 + "refreshToken": "string",
47 + "passwordExpired": true
42 42  }
43 43  {{/code}}
44 44  
45 -=== ===
46 46  
47 47  
48 -
49 49  === Schema ===
50 50  
51 -{{code language="none"}}
55 +(% data-xwiki-non-generated-content="java.util.List" %)
56 +(((
57 +
58 +)))
59 +
60 +{{success}}
52 52  AuthResponse{
53 -accessToken string
54 -nullable: true
62 +
63 +|accessToken|string
64 +nullable: true
65 +|refreshToken|string
66 +nullable: true
67 +|passwordExpired|boolean
68 +
55 55  }
56 -{{/code}}
70 +{{/success}}
71 +
72 +
73 +== Important ==
74 +
75 +{{error}}
76 +=== Implementing Authorization in Subsequent Requests ===
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:
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.
82 +
83 +Additionally, to ensure your requests are properly formatted and recognized, include the following headers:
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.
88 +
89 +Incorporating these headers with their respective values is essential for the successful processing of your API requests.
90 +{{/error}}