Description
This documentation provides details about the usage of the POST API endpoint, which allows clients to submit data to the server.
Base URL
https://pushrocket.one
Authentication
Not required Authorization: Bearer
https://pushrocket.one
1. Endpoint: Get Website List
Endpoint
POST /api/User/GetWebsiteList
Description
This API endpoint allows clients to get website list.
Request Headers
| Header | Value | Required | Description |
| Content-Type | application/json | Yes | Indicates the format of the request payload |
Request Body
The request body should contain a JSON object with the user details.
{
"WebsiteURL": "abcd.one",
"WebsiteCode": "kjh43g765",
"UserName": "abcd",
"Password": "abcd@123#"
}
Response
1. Success Response (Status = true)
{
"Status": true,
"Message": "2 Website are exist !",
"Data": [
{
"Id": 1,
"WebsiteName": "abcd.com"
},
{
"Id": 2,
"WebsiteName": "efgh.com"
}
]
}
Error Responses
2. Success Response (Status = false)
{
"Status": true,
"Message": "Email Id or Password are Incorrect !",
"Data": null
}
3. Success Response (Status = false)
{
"Status": true,
"Message": "Website Code or Website URL are Incorrect !",
"Data": null
}
.,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
2. Endpoint: Send Notification
Endpoint
POST /api/User/SendNotification
Description
This API endpoint allows clients to send notification.
Request Headers
| Header | Value | Required | Description |
| Content-Type | application/json | Yes | Indicates the format of the request payload |
Request Body
The request body should contain a JSON object with the user details.
{
"WebsiteURL": "abcd.one",
"WebsiteCode": "kjh43g765",
"UserName": "abcd",
"Password": "abcd@123#",
"WebsiteList": "1,2,3",
"MetaTitle": "Meta Title",
"MetaDescription": "Meta Description",
"ImageURL": "Image URL",
"PostType": "Web stories/Blog Post",
"PostURL": "posturl"
}
Response
1. Success Response (Status = true)
{
"Status": true,
"Message": "Notifiaction send successfully !",
"Data": null
}
Error Responses
2. Success Response (Status = false)
{
"Status": true,
"Message": "Email Id or Password are Incorrect !",
"Data": null
}
3. Success Response (Status = false)
{
"Status": true,
"Message": "Website Code or Website URL are Incorrect !",
"Data": null
}
.,..................................................
Notes
Customize the endpoints, headers, and payload structure according to your API.
Ensure that your API documentation includes detailed information about error responses and possible scenarios.
Use these templates as a starting point and adapt them to your specific API requirements.