Wiki source code of 1. Authorization
Version 30.2 by Giorgi Mdivnishvili on 2024/04/11 15:35
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% data-xwiki-non-generated-content="java.util.List" %) | ||
| 2 | ((( | ||
| 3 | |||
| 4 | ))) | ||
| 5 | |||
| 6 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 7 | {{toc/}} | ||
| 8 | {{/box}} | ||
| 9 | |||
| 10 | = Authorization: Starting Your Integration = | ||
| 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. | ||
| 13 | |||
| 14 | |||
| 15 | == Request URL - [POST] == | ||
| 16 | |||
| 17 | (% class="box infomessage" %) | ||
| 18 | ((( | ||
| 19 | [[https:~~/~~/integration.kazunion.com/api/Auth/Auth>>https://integration.kazunion.com/api/Auth/Auth]] | ||
| 20 | ))) | ||
| 21 | |||
| 22 | |||
| 23 | == Request Parameters == | ||
| 24 | |||
| 25 | (% class="box" %) | ||
| 26 | ((( | ||
| 27 | none | ||
| 28 | ))) | ||
| 29 | |||
| 30 | |||
| 31 | == Request Body == | ||
| 32 | |||
| 33 | {{code language="Json"}} | ||
| 34 | { | ||
| 35 | "login": "string", | ||
| 36 | "password": "string" | ||
| 37 | } | ||
| 38 | {{/code}} | ||
| 39 | |||
| 40 | |||
| 41 | == Response Body == | ||
| 42 | |||
| 43 | {{code language="Json"}} | ||
| 44 | { | ||
| 45 | "accessToken": "string", | ||
| 46 | "refreshToken": "string", | ||
| 47 | "passwordExpired": true | ||
| 48 | } | ||
| 49 | {{/code}} | ||
| 50 | |||
| 51 | |||
| 52 | |||
| 53 | === Schema === | ||
| 54 | |||
| 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 | |||
| 69 | } | ||
| 70 | {{/success}} | ||
| 71 | |||
| 72 | |||
| 73 | == Important == | ||
| 74 | |||
| 75 | {{error}} | ||
| 76 | It's Important to in every other request header, put Auth token | ||
| 77 | |||
| 78 | **Key **- Authorization | ||
| 79 | |||
| 80 | **Value **- Bearer Token what is given in this response. (Authorization type Bearer Token) | ||
| 81 | |||
| 82 | |||
| 83 | **also note in headers that:** | ||
| 84 | |||
| 85 | Content-Type - application/json | ||
| 86 | |||
| 87 | **Key - **X-nugios-timezone | ||
| 88 | |||
| 89 | **Value **- 240 | ||
| 90 | {{/error}} |