mirror of
https://github.com/ajayyy/SponsorBlock.git
synced 2025-12-31 11:56:40 +03:00
Updated API Docs (markdown)
52
API-Docs.md
52
API-Docs.md
@@ -325,6 +325,56 @@ __________________________________________________________________
|
|||||||
|
|
||||||
These can only be called by the users added to the VIP table.
|
These can only be called by the users added to the VIP table.
|
||||||
|
|
||||||
|
**GET** `/api/isUserVIP`
|
||||||
|
|
||||||
|
**Input**:
|
||||||
|
```
|
||||||
|
{
|
||||||
|
userID: string, // private userID
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response**:
|
||||||
|
```
|
||||||
|
{
|
||||||
|
hashedUserID: string,
|
||||||
|
vip: boolean
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Error codes**:
|
||||||
|
|
||||||
|
400: Bad Request (Your inputs are wrong/impossible)
|
||||||
|
|
||||||
|
__________________________________________________________________
|
||||||
|
|
||||||
|
**POST** `/api/noSegments`
|
||||||
|
|
||||||
|
Will block new segment submissions of the specified category on that video.
|
||||||
|
|
||||||
|
**Input** (Request Body):
|
||||||
|
```
|
||||||
|
{
|
||||||
|
videoID: string,
|
||||||
|
userID: string,
|
||||||
|
categories: string[]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response**:
|
||||||
|
```
|
||||||
|
{
|
||||||
|
Nothing (status code 200)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Error codes**:
|
||||||
|
|
||||||
|
400: Bad Request (Your inputs are wrong/impossible)
|
||||||
|
403: Unauthorized (You are not a VIP)
|
||||||
|
|
||||||
|
__________________________________________________________________
|
||||||
|
|
||||||
**POST** `/api/shadowBanUser`
|
**POST** `/api/shadowBanUser`
|
||||||
|
|
||||||
Shadow banned submissions are hidden for everyone but the IP that originally submitted it. Shadow banning a user shadow bans all future submissions.
|
Shadow banned submissions are hidden for everyone but the IP that originally submitted it. Shadow banning a user shadow bans all future submissions.
|
||||||
@@ -349,7 +399,7 @@ Shadow banned submissions are hidden for everyone but the IP that originally sub
|
|||||||
**Error codes**:
|
**Error codes**:
|
||||||
|
|
||||||
400: Bad Request (Your inputs are wrong/impossible)
|
400: Bad Request (Your inputs are wrong/impossible)
|
||||||
403: Unauthorized (You are not an admin)
|
403: Unauthorized (You are not a VIP)
|
||||||
__________________________________________________________________
|
__________________________________________________________________
|
||||||
|
|
||||||
### Admin Calls
|
### Admin Calls
|
||||||
|
|||||||
Reference in New Issue
Block a user