Skip to Content

Changes for page 1. Authorization

Last modified by Giorgi Mdivnishvili on 2024/04/26 15:59
From version 33.1
edited by Giorgi Mdivnishvili
on 2024/04/16 18:43
Change comment: There is no comment for this version
To version 28.1
edited by Giorgi Mdivnishvili
on 2024/04/11 15:33
Change comment: There is no comment for this version

Summary

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,13 +64,12 @@
64 64  )))
65 65  
66 66  {{success}}
67 -AuthResponse{
62 +AuthRequest{
68 68  
69 -|accessToken|string
64 +|login|string
70 70  nullable: true
71 -|refreshToken|string
66 +|password|string
72 72  nullable: true
73 -|passwordExpired|boolean
74 74  
75 75  }
76 76  {{/success}}
... ... @@ -79,18 +79,18 @@
79 79  == Important ==
80 80  
81 81  {{error}}
82 -=== Implementing Authorization in Subsequent Requests ===
76 +It's Important to in every other request header, put Auth token
83 83  
84 -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:
78 +**Key **- Authorization
85 85  
86 -* **Header Key:** Authorization
87 -* **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)
88 88  
89 -Additionally, to ensure your requests are properly formatted and recognized, include the following headers:
90 90  
91 -* **Content-Type:** Specify this header as application/json to indicate the format of the request body.
92 -* **Header Key:** X-nugios-timezone
93 -* **Header Value:** 240 - Adjust this value to match your local timezone offset in minutes.
83 +**also note in headers that:**
94 94  
95 -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
96 96  {{/error}}