REST API Authorization: Difference between revisions
From Planfix
No edit summary |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 6: | Line 6: | ||
}} | }} | ||
Each request must include a bearer HTTP authentication header. Authentication tokens are created in the section '''Account Management''' — '''API | Each request must include a bearer HTTP authentication header. Authentication tokens are created in the section '''Account Management''' — '''Access to API''' — '''REST API''' and can only be restricted by specific access levels - scope: | ||
https://s.pfx.so/pf/Pt/jwF7jI.png | |||
In the example on the screenshot, an authorization token is created, and when used, requests are made on behalf of the employee Vladislav Ivanov (i.e., requests for tasks only the contacts available to him). | In the example on the screenshot, an authorization token is created, and when used, requests are made on behalf of the employee Vladislav Ivanov (i.e., requests for tasks only the contacts available to him). | ||
| Line 15: | Line 16: | ||
The bearer authorization header looks like this: | The bearer authorization header looks like this: | ||
<div style="display: block; padding: 1em; margin: 0 0 10px; font-size: 13px; line-height: 1.65; color: black; word-wrap: break-word; background-color: #f9f9f9; border: 1px solid #ddd; border-radius: 4px;">Authorization : Bearer 5d80e21cb3e12345678bdd568a2226d5</div> | <div style="display: block; padding: 1em; margin: 0 0 10px; font-size: 13px; line-height: 1.65; color: black; word-wrap: break-word; background-color: #f9f9f9; border: 1px solid #ddd; border-radius: 4px;">Authorization : Bearer 5d80e21cb3e12345678bdd568a2226d5</div> | ||
The authorization token is passed as a parameter for GET requests: '''access_token'''. | The authorization token is passed as a parameter for GET requests: '''access_token'''. | ||
Latest revision as of 15:58, 17 November 2023
Each request must include a bearer HTTP authentication header. Authentication tokens are created in the section Account Management — Access to API — REST API and can only be restricted by specific access levels - scope:
In the example on the screenshot, an authorization token is created, and when used, requests are made on behalf of the employee Vladislav Ivanov (i.e., requests for tasks only the contacts available to him).
If API access is required with the ability to modify all contacts, then a robot should be used for these purposes.
The bearer authorization header looks like this:
Authorization : Bearer 5d80e21cb3e12345678bdd568a2226d5
The authorization token is passed as a parameter for GET requests: access_token.