Skip to Content

Changes for page 1. Authorization

Last modified by Giorgi Mdivnishvili on 2024/04/26 15:59
From version 32.1
edited by Giorgi Mdivnishvili
on 2024/04/16 18:43
Change comment: There is no comment for this version
To version 27.1
edited by Giorgi Mdivnishvili
on 2024/01/09 14:19
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -7,9 +7,9 @@
7 7  {{toc/}}
8 8  {{/box}}
9 9  
10 -= Authorization: Starting Your Integration =
10 += Method Description =
11 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.
12 +The initial method of the integration process is authorization. You will be provided with a  unique user username and password to generate the access token that you will need to pass in all the following methods.
13 13  
14 14  
15 15  == Request URL - [POST] ==
... ... @@ -42,19 +42,12 @@
42 42  
43 43  {{code language="Json"}}
44 44  {
45 - "accessToken": "string",
46 - "refreshToken": "string",
47 - "passwordExpired": true
45 + "accessToken": "string"
48 48  }
49 49  {{/code}}
50 50  
51 -expiration time 30 days for both tokens:
52 52  
53 -accessToken - 43200 min
54 54  
55 -refreshToken - 2591968 sec
56 -
57 -
58 58  === Schema ===
59 59  
60 60  (% data-xwiki-non-generated-content="java.util.List" %)
... ... @@ -63,13 +63,12 @@
63 63  )))
64 64  
65 65  {{success}}
66 -AuthResponse{
59 +AuthRequest{
67 67  
68 -|accessToken|string
61 +|login|string
69 69  nullable: true
70 -|refreshToken|string
63 +|password|string
71 71  nullable: true
72 -|passwordExpired|boolean
73 73  
74 74  }
75 75  {{/success}}
... ... @@ -78,18 +78,18 @@
78 78  == Important ==
79 79  
80 80  {{error}}
81 -=== Implementing Authorization in Subsequent Requests ===
73 +It's Important to in every other request header, put Auth token
82 82  
83 -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:
75 +**Key **- Authorization
84 84  
85 -* **Header Key:** Authorization
86 -* **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.
77 +**Value **- Bearer Token what is given in this response. (Authorization type Bearer Token)
87 87  
88 -Additionally, to ensure your requests are properly formatted and recognized, include the following headers:
89 89  
90 -* **Content-Type:** Specify this header as application/json to indicate the format of the request body.
91 -* **Header Key:** X-nugios-timezone
92 -* **Header Value:** 240 - Adjust this value to match your local timezone offset in minutes.
80 +**also note in headers that:**
93 93  
94 -Incorporating these headers with their respective values is essential for the successful processing of your API requests.
82 +Content-Type - application/json
83 +
84 +**Key - **X-nugios-timezone
85 +
86 +**Value **- 240
95 95  {{/error}}