Changes for page 1. Authorization
Last modified by Giorgi Mdivnishvili on 2024/04/26 15:59
From version 35.1
edited by Giorgi Mdivnishvili
on 2024/04/26 15:59
on 2024/04/26 15:59
Change comment:
There is no comment for this version
To version 28.1
edited by Giorgi Mdivnishvili
on 2024/04/11 15:33
on 2024/04/11 15:33
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -7,8 +7,11 @@ 7 7 {{toc/}} 8 8 {{/box}} 9 9 10 -= Authorization:Starting Your Integration =10 += Method Description = 11 11 12 + 13 +=== Authorization: Starting Your Integration === 14 + 12 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. 13 13 14 14 ... ... @@ -42,20 +42,12 @@ 42 42 43 43 {{code language="Json"}} 44 44 { 45 - "accessToken": "string", 46 - "refreshToken": "string", 47 - "passwordExpired": true 48 + "accessToken": "string" 48 48 } 49 49 {{/code}} 50 50 51 51 52 -expiration time 30 days for both tokens: 53 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" %) ... ... @@ -64,77 +64,32 @@ 64 64 ))) 65 65 66 66 {{success}} 67 -AuthRe sponse{62 +AuthRequest{ 68 68 69 -| accessToken|string64 +|login|string 70 70 nullable: true 71 -| refreshToken|string66 +|password|string 72 72 nullable: true 73 -|passwordExpired|boolean 74 74 75 75 } 76 76 {{/success}} 77 77 78 78 79 - 80 - 81 -= RefreshToken = 82 - 83 - 84 -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. 85 - 86 - 87 -== Request URL - [POST] == 88 - 89 -(% class="box infomessage" %) 90 -((( 91 -[[https:~~/~~/integration.kazunion.com/api/Auth/RefreshToken>>https://integration.kazunion.com/api/Auth/RefreshToken]] 92 -))) 93 - 94 - 95 -== Request Parameters == 96 - 97 -(% class="box" %) 98 -((( 99 -none 100 -))) 101 - 102 - 103 -== (% id="cke_bm_5539S" style="display:none" %) (%%)Request Body example == 104 - 105 -{{code language="Json"}} 106 -{ 107 - "refreshToken": "string" 108 -} 109 -{{/code}} 110 - 111 - 112 -== (% id="cke_bm_11208S" style="display:none" %) (%%)Response Body == 113 - 114 -{{code language="Json"}} 115 -{ 116 - "accessToken": "string", 117 - "refreshToken": "string", 118 - "passwordExpired": true 119 -} 120 -{{/code}} 121 - 122 - 123 123 == Important == 124 124 125 125 {{error}} 126 - ===ImplementingAuthorizationinSubsequentRequests===76 +It's Important to in every other request header, put Auth token 127 127 128 - Forevery API requestafter the initial authentication, it's crucial to include the authorizationtoken in the request header. This ensures your requests are authorized and can access the necessary resources. Here's how to properly include your token:78 +**Key **- Authorization 129 129 130 -* **Header Key:** Authorization 131 -* **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. 80 +**Value **- Bearer Token what is given in this response. (Authorization type Bearer Token) 132 132 133 -Additionally, to ensure your requests are properly formatted and recognized, include the following headers: 134 134 135 -* **Content-Type:** Specify this header as application/json to indicate the format of the request body. 136 -* **Header Key:** X-nugios-timezone 137 -* **Header Value:** 240 - Adjust this value to match your local timezone offset in minutes. 83 +**also note in headers that:** 138 138 139 -Incorporating these headers with their respective values is essential for the successful processing of your API requests. 85 +Content-Type - application/json 86 + 87 +**Key - **X-nugios-timezone 88 + 89 +**Value **- 240 140 140 {{/error}}