Wiki source code of 1. Authorization
Version 34.1 by Giorgi Mdivnishvili on 2024/04/26 15:58
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
19.1 | 1 | (% data-xwiki-non-generated-content="java.util.List" %) |
| 2 | ((( | ||
| |
21.1 | 3 | |
| |
19.1 | 4 | ))) |
| 5 | |||
| |
1.1 | 6 | {{box cssClass="floatinginfobox" title="**Contents**"}} |
| 7 | {{toc/}} | ||
| 8 | {{/box}} | ||
| 9 | |||
| |
30.1 | 10 | = Authorization: Starting Your Integration = |
| |
1.1 | 11 | |
| |
28.1 | 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 | |||
| 14 | |||
| |
22.1 | 15 | == Request URL - [POST] == |
| |
1.1 | 16 | |
| |
6.1 | 17 | (% class="box infomessage" %) |
| 18 | ((( | ||
| |
25.1 | 19 | [[https:~~/~~/integration.kazunion.com/api/Auth/Auth>>https://integration.kazunion.com/api/Auth/Auth]] |
| |
6.1 | 20 | ))) |
| |
1.1 | 21 | |
| |
6.1 | 22 | |
| |
1.1 | 23 | == Request Parameters == |
| 24 | |||
| |
6.1 | 25 | (% class="box" %) |
| 26 | ((( | ||
| |
1.1 | 27 | none |
| |
6.1 | 28 | ))) |
| |
1.1 | 29 | |
| |
6.1 | 30 | |
| |
1.1 | 31 | == Request Body == |
| 32 | |||
| 33 | {{code language="Json"}} | ||
| 34 | { | ||
| 35 | "login": "string", | ||
| 36 | "password": "string" | ||
| 37 | } | ||
| 38 | {{/code}} | ||
| 39 | |||
| |
9.1 | 40 | |
| |
1.1 | 41 | == Response Body == |
| 42 | |||
| 43 | {{code language="Json"}} | ||
| 44 | { | ||
| |
30.2 | 45 | "accessToken": "string", |
| 46 | "refreshToken": "string", | ||
| 47 | "passwordExpired": true | ||
| |
1.1 | 48 | } |
| 49 | {{/code}} | ||
| 50 | |||
| |
33.1 | 51 | |
| |
32.1 | 52 | expiration time 30 days for both tokens: |
| |
12.1 | 53 | |
| |
32.1 | 54 | accessToken - 43200 min |
| |
27.1 | 55 | |
| |
32.1 | 56 | refreshToken - 2591968 sec |
| 57 | |||
| 58 | |||
| |
1.1 | 59 | === Schema === |
| 60 | |||
| |
19.1 | 61 | (% data-xwiki-non-generated-content="java.util.List" %) |
| 62 | ((( | ||
| |
26.1 | 63 | |
| |
19.1 | 64 | ))) |
| 65 | |||
| |
11.1 | 66 | {{success}} |
| |
30.2 | 67 | AuthResponse{ |
| |
11.1 | 68 | |
| |
30.2 | 69 | |accessToken|string |
| |
11.1 | 70 | nullable: true |
| |
30.2 | 71 | |refreshToken|string |
| |
11.1 | 72 | nullable: true |
| |
30.2 | 73 | |passwordExpired|boolean |
| |
11.1 | 74 | |
| |
3.1 | 75 | } |
| |
11.1 | 76 | {{/success}} |
| 77 | |||
| |
16.1 | 78 | |
| 79 | |||
| |
34.1 | 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]] | ||
| 94 | ))) | ||
| 95 | |||
| 96 | |||
| 97 | == Request Parameters == | ||
| 98 | |||
| 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" | ||
| 111 | } | ||
| 112 | {{/code}} | ||
| 113 | |||
| 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 | |||
| |
16.1 | 130 | {{error}} |
| |
31.1 | 131 | === Implementing Authorization in Subsequent Requests === |
| |
16.1 | 132 | |
| |
31.1 | 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: |
| |
16.1 | 134 | |
| |
31.1 | 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. | ||
| |
16.1 | 137 | |
| |
31.1 | 138 | Additionally, to ensure your requests are properly formatted and recognized, include the following headers: |
| |
16.1 | 139 | |
| |
31.1 | 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. | ||
| |
16.1 | 143 | |
| |
31.1 | 144 | Incorporating these headers with their respective values is essential for the successful processing of your API requests. |
| |
16.1 | 145 | {{/error}} |