Changes for page 1. Authorization

Summary

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

Details

Page properties

Content

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