Wiki source code of 1. Authorization
Version 29.1 by Giorgi Mdivnishvili on 2024/04/11 15:33
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 | = Method Description = | ||
11 | |||
12 | |||
13 | == Authorization: Starting Your Integration == | ||
14 | |||
15 | 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. | ||
16 | |||
17 | |||
18 | == Request URL - [POST] == | ||
19 | |||
20 | (% class="box infomessage" %) | ||
21 | ((( | ||
22 | [[https:~~/~~/integration.kazunion.com/api/Auth/Auth>>https://integration.kazunion.com/api/Auth/Auth]] | ||
23 | ))) | ||
24 | |||
25 | |||
26 | == Request Parameters == | ||
27 | |||
28 | (% class="box" %) | ||
29 | ((( | ||
30 | none | ||
31 | ))) | ||
32 | |||
33 | |||
34 | == Request Body == | ||
35 | |||
36 | {{code language="Json"}} | ||
37 | { | ||
38 | "login": "string", | ||
39 | "password": "string" | ||
40 | } | ||
41 | {{/code}} | ||
42 | |||
43 | |||
44 | == Response Body == | ||
45 | |||
46 | {{code language="Json"}} | ||
47 | { | ||
48 | "accessToken": "string" | ||
49 | } | ||
50 | {{/code}} | ||
51 | |||
52 | |||
53 | |||
54 | === Schema === | ||
55 | |||
56 | (% data-xwiki-non-generated-content="java.util.List" %) | ||
57 | ((( | ||
58 | |||
59 | ))) | ||
60 | |||
61 | {{success}} | ||
62 | AuthRequest{ | ||
63 | |||
64 | |login|string | ||
65 | nullable: true | ||
66 | |password|string | ||
67 | nullable: true | ||
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}} |