Changes for page 1. Authorization

Last modified by Giorgi Mdivnishvili on 2024/04/26 15:59

From version 4.1
edited by Giorgi Mdivnishvili
on 2023/12/14 07:37
Change comment: There is no comment for this version
To version 31.2
edited by Giorgi Mdivnishvili
on 2024/04/11 15:37
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,19 +1,33 @@
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 -== Request URL - [GET] ==
10 10  
11 -{{{https://online-api.kazunion.com/api/Auth/Auth}}}
15 +== Request URL - [POST] ==
12 12  
17 +(% class="box infomessage" %)
18 +(((
19 +[[https:~~/~~/integration.kazunion.com/api/Auth/Auth>>https://integration.kazunion.com/api/Auth/Auth]]
20 +)))
21 +
22 +
13 13  == Request Parameters ==
14 14  
25 +(% class="box" %)
26 +(((
15 15  none
28 +)))
16 16  
30 +
17 17  == Request Body ==
18 18  
19 19  {{code language="Json"}}
... ... @@ -23,45 +23,54 @@
23 23  }
24 24  {{/code}}
25 25  
40 +
26 26  == Response Body ==
27 27  
28 28  {{code language="Json"}}
29 29  {
30 - "accessToken": "string"
45 + "accessToken": "string",
46 + "refreshToken": "string",
47 + "passwordExpired": true
31 31  }
32 32  {{/code}}
33 33  
51 +
52 +
34 34  === Schema ===
35 35  
36 -{{code language="none"}}
37 -GetCountriesResponse{
38 -error boolean
39 -errorCode string
40 -nullable: true
41 -errorDescription string
42 -nullable: true
43 -userErrorDescription string
44 -nullable: true
45 -countries [
46 -nullable: true
47 -Country{
48 -countryCode string
49 -nullable: true
50 -readOnly: true
51 -countryName string
52 -nullable: true
53 -note string
54 -nullable: true
55 -phoneCode string
56 -nullable: true
57 -isO2 string
58 -nullable: true
59 -isO3 string
60 -nullable: true
61 -status integer($int32)
62 -sortingOrder integer($int32)
63 -sellCurrency string
64 -nullable: true
65 -}]
55 +(% data-xwiki-non-generated-content="java.util.List" %)
56 +(((
57 +
58 +)))
59 +
60 +{{success}}
61 +AuthResponse{
62 +
63 +|accessToken|string
64 +nullable: true
65 +|refreshToken|string
66 +nullable: true
67 +|passwordExpired|boolean
68 +
66 66  }
67 -{{/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}}