Changes for page 1. Authorization

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -1,22 +1,29 @@
1	1	(% data-xwiki-non-generated-content="java.util.List" %)
2	2	(((
3		-
	3	+" data-xwiki-parameter-name="title" class="xwiki-metadata-container">**Contents**
4	4	)))
5	5
	6	+(% data-xwiki-non-generated-content="java.util.List" %)
	7	+(((
	8	+" class="xwiki-metadata-container">
	9	+
	10	+{{toc/}}
	11	+)))
	12	+
6	6	{{box cssClass="floatinginfobox" title="**Contents**"}}
7	7	{{toc/}}
8	8	{{/box}}
9	9
10		-= Authorization: Starting Your Integration =
	17	+= 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.
	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.
13	13
14	14
15		-== Request URL - [POST] ==
	22	+== Request URL - [GET] ==
16	16
17	17	(% class="box infomessage" %)
18	18	(((
19		-[[https:~~/~~/integration.kazunion.com/api/Auth/Auth>>https://integration.kazunion.com/api/Auth/Auth]]
	26	+https:~/~/online-api.kazunion.com/api/Auth/Auth
20	20	)))
21	21
22	22
...	...	@@ -42,104 +42,72 @@
42	42
43	43	{{code language="Json"}}
44	44	{
45		- "accessToken": "string",
46		- "refreshToken": "string",
47		- "passwordExpired": true
	52	+ "accessToken": "string"
48	48	}
49	49	{{/code}}
50	50
51	51
52		-expiration time 30 days for both tokens:
53		-
54		-accessToken - 43200 min
55		-
56		-refreshToken - 2591968 sec
57		-
58		-
59	59	=== Schema ===
60	60
61	61	(% data-xwiki-non-generated-content="java.util.List" %)
62	62	(((
63		-
	61	+" class="xwiki-metadata-container">AuthRequest{
	62	+
	63	+|login|string
	64	+nullable: true
	65	+|password|string
	66	+nullable: true
	67	+
	68	+}
64	64	)))
65	65
66	66	{{success}}
67		-AuthResponse{
	72	+AuthRequest{
68	68
69		-|accessToken|string
	74	+|login|string
70	70	nullable: true
71		-|refreshToken|string
	76	+|password|string
72	72	nullable: true
73		-|passwordExpired|boolean
74	74
75	75	}
76	76	{{/success}}
77	77
78	78
	83	+== Important ==
79	79
	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
80	80
	89	+**Key **- Authorization
81	81
	91	+**Value **- Bearer Token what is given in this response.
82	82
83		-= RefreshToken =
84	84
	94	+**also note in headers that:**
85	85
86		-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.
	96	+Content-Type - application/json
87	87
	98	+**Key - **X-nugios-timezone
88	88
89		-== Request URL - [POST] ==
90		-
91		-(% class="box infomessage" %)
92		-(((
93		-[[https:~~/~~/integration.kazunion.com/api/Auth/RefreshToken>>https://integration.kazunion.com/api/Auth/RefreshToken]]
	100	+**Value **- 240
94	94	)))
95	95
	103	+{{error}}
	104	+It's Important to in every other request header, put Auth token
96	96
97		-== Request Parameters ==
	106	+**Key **- Authorization
98	98
99		-(% class="box" %)
100		-(((
101		-none
102		-)))
	108	+**Value **- Bearer Token what is given in this response.
103	103
104		-== ==
105	105
106		-== (% id="cke_bm_5539S" style="display:none" %) (%%)Request Body example ==
	111	+**also note in headers that:**
107	107
108		-{{code language="Json"}}
109		-{
110		- "refreshToken": "string"
111		-}
112		-{{/code}}
	113	+Content-Type - application/json
113	113
	115	+**Key - **X-nugios-timezone
114	114
115		-== (% id="cke_bm_11208S" style="display:none" %) (%%)Response Body ==
116		-
117		-{{code language="Json"}}
118		-{
119		- "accessToken": "string",
120		- "refreshToken": "string",
121		- "passwordExpired": true
122		-}
123		-{{/code}}
124		-
125		-
126		-== ==
127		-
128		-== Important ==
129		-
130		-{{error}}
131		-=== Implementing Authorization in Subsequent Requests ===
132		-
133		-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:
134		-
135		-* **Header Key:** Authorization
136		-* **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.
137		-
138		-Additionally, to ensure your requests are properly formatted and recognized, include the following headers:
139		-
140		-* **Content-Type:** Specify this header as application/json to indicate the format of the request body.
141		-* **Header Key:** X-nugios-timezone
142		-* **Header Value:** 240 - Adjust this value to match your local timezone offset in minutes.
143		-
144		-Incorporating these headers with their respective values is essential for the successful processing of your API requests.
	117	+**Value **- 240
145	145	{{/error}}
	119	+
	120	+