API documetation
MCP DocsThe SHOYO.WORK API allows you to retrieve page data programmatically. All API endpoints return JSON responses and support access to both public and resticted pages.
Base url:https://api.shoyo.work/api/v1How To
- Choose your preferred HTTP method (GET or POST)
- Replace {identifier} with your page UID or vanity
- Add a password or contact information if the page is resticted
- Make the request and handle the JSON response
GET/page/{identifier}
Retrieve public or protected page data using the page identifier. Supports optional authentication via query string.
Required unique identifier for the page. Can be the UID or vanity.
Optional password if the page requires any.
Optional contact information if the page requires any. Can be an email or phone number depending on the page's requirement.
Optional session UID for tracking.
Example request
curl -X GET "https://api.shoyo.work/api/v1/page/your-page-id?password=your-password&[email protected]"200Page data retrieved successfully.
{
"success": true,
"data": "<object: page data>"
}401Password required or incorrect.
{
"success": false,
"error": "Password required or incorrect"
}403Contact info required.
{
"success": false,
"error": "Contact info required for preference: [email | phone]"
}404Page not found or password incorrect.
{
"success": false,
"error": "Page not found or password incorrect"
}500Internal server or database error.
POST/page/{identifier}
Retrieve public or protected page data using the page identifier. Supports optional authentication via the request body in JSON format.
Required unique identifier for the page. Can be the UID or vanity.
Optional password if the page requires any.
Optional contact information if the page requires any. Can be an email or phone number depending on the page's requirement.
Optional session UID for tracking.
Example request
curl -X POST "https://api.shoyo.work/api/v1/page/your-page-id" \
-H "Content-Type: application/json" \
-d '{
"password": "your-password",
"contact": "[email protected]",
"session_uid": "unique-session-id"
}'200Page data retrieved successfully.
{
"success": true,
"data": "<object: page data>"
}400Invalid JSON or missing body.
{
"success": false,
"error": "Invalid JSON body"
}401Password required or incorrect.
{
"success": false,
"error": "Password required or incorrect"
}403Contact info required.
{
"success": false,
"error": "Contact info required for preference: [email | phone]"
}404Page not found.
{
"success": false,
"error": "Page not found or password incorrect"
}422Validation failed on input.
{
"success": false,
"error": "Validation failed: <error detail>"
}500Internal server or database error.